Remove deprecated dashboard-access route from lib-openapi.json (#1875)

We removed it from the cloud spec, need to remove it here to clear the
way for future spec updates. Surprisingly annoying to keep the
deprecated methods around in some languages.

Ruby was easiest: Literally just copying the diff for the deleted method
to an `api_extra` file, regen, done.
Python and JavaScript were the most annoying, because I couldn't think
of a nice way of keeping the query struct around.

Author: svix-jplatte

csharp/Svix/Authentication.cs

@@ -29,18 +29,6 @@ public class AuthenticationExpireAllOptions : SvixOptionsBase
         }
     }
 
-    public class AuthenticationDashboardAccessOptions : SvixOptionsBase
-    {
-        public string? IdempotencyKey { get; set; }
-
-        public new Dictionary<string, string> HeaderParams()
-        {
-            return SerializeParams(
-                new Dictionary<string, object?> { { "idempotency-key", IdempotencyKey } }
-            );
-        }
-    }
-
     public class AuthenticationLogoutOptions : SvixOptionsBase
     {
         public string? IdempotencyKey { get; set; }
@@ -187,12 +175,7 @@ public bool ExpireAll(
             }
         }
 
-        /// <summary>
-        /// DEPRECATED: Please use `app-portal-access` instead.
-        ///
-        /// Use this function to get magic links (and authentication codes) for connecting your users to the Consumer Application Portal.
-        /// </summary>
-        [Obsolete]
+        [Obsolete("Please use `AppPortalAccessAsync` instead")]
         public async Task<DashboardAccessOut> DashboardAccessAsync(
             string appId,
             AuthenticationDashboardAccessOptions? options = null,
@@ -219,12 +202,7 @@ public async Task<DashboardAccessOut> DashboardAccessAsync(
             }
         }
 
-        /// <summary>
-        /// DEPRECATED: Please use `app-portal-access` instead.
-        ///
-        /// Use this function to get magic links (and authentication codes) for connecting your users to the Consumer Application Portal.
-        /// </summary>
-        [Obsolete]
+        [Obsolete("Please use `AppPortalAccess` instead")]
         public DashboardAccessOut DashboardAccess(
             string appId,
             AuthenticationDashboardAccessOptions? options = null

csharp/Svix/Deprecated.cs

@@ -0,0 +1,17 @@
+#nullable enable
+
+namespace Svix
+{
+    [Obsolete]
+    public class AuthenticationDashboardAccessOptions : SvixOptionsBase
+    {
+        public string? IdempotencyKey { get; set; }
+
+        public new Dictionary<string, string> HeaderParams()
+        {
+            return SerializeParams(
+                new Dictionary<string, object?> { { "idempotency-key", IdempotencyKey } }
+            );
+        }
+    }
+}

csharp/templates/api_extra/authentication_expire_all.cs

@@ -0,0 +1,51 @@
+[Obsolete("Please use `AppPortalAccessAsync` instead")]
+public async Task<DashboardAccessOut> DashboardAccessAsync(
+    string appId,
+    AuthenticationDashboardAccessOptions? options = null,
+    CancellationToken cancellationToken = default
+)
+{
+    try
+    {
+        var response = await _client.SvixHttpClient.SendRequestAsync<DashboardAccessOut>(
+            method: HttpMethod.Post,
+            path: "/api/v1/auth/dashboard-access/{app_id}",
+            pathParams: new Dictionary<string, string> { { "app_id", appId } },
+            queryParams: options?.QueryParams(),
+            headerParams: options?.HeaderParams(),
+            cancellationToken: cancellationToken
+        );
+        return response.Data;
+    }
+    catch (ApiException e)
+    {
+        _client.Logger?.LogError(e, $"{nameof(DashboardAccessAsync)} failed");
+
+        throw;
+    }
+}
+
+[Obsolete("Please use `AppPortalAccess` instead")]
+public DashboardAccessOut DashboardAccess(
+    string appId,
+    AuthenticationDashboardAccessOptions? options = null
+)
+{
+    try
+    {
+        var response = _client.SvixHttpClient.SendRequest<DashboardAccessOut>(
+            method: HttpMethod.Post,
+            path: "/api/v1/auth/dashboard-access/{app_id}",
+            pathParams: new Dictionary<string, string> { { "app_id", appId } },
+            queryParams: options?.QueryParams(),
+            headerParams: options?.HeaderParams()
+        );
+        return response.Data;
+    }
+    catch (ApiException e)
+    {
+        _client.Logger?.LogError(e, $"{nameof(DashboardAccess)} failed");
+
+        throw;
+    }
+}

go/authentication.go

@@ -25,10 +25,6 @@ type AuthenticationExpireAllOptions struct {
 	IdempotencyKey *string
 }
 
-type AuthenticationDashboardAccessOptions struct {
-	IdempotencyKey *string
-}
-
 type AuthenticationLogoutOptions struct {
 	IdempotencyKey *string
 }
@@ -94,9 +90,7 @@ func (authentication *Authentication) ExpireAll(
 	return err
 }
 
-// DEPRECATED: Please use `app-portal-access` instead.
-//
-// Use this function to get magic links (and authentication codes) for connecting your users to the Consumer Application Portal.
+// Deprecated: Please use `AppPortalAccess` instead.
 func (authentication *Authentication) DashboardAccess(
 	ctx context.Context,
 	appId string,

go/deprecated.go

@@ -0,0 +1,5 @@
+package svix
+
+type AuthenticationDashboardAccessOptions struct {
+	IdempotencyKey *string
+}

java/lib/src/main/java/com/svix/api/Authentication.java

@@ -6,7 +6,6 @@
 import com.svix.models.AppPortalAccessIn;
 import com.svix.models.AppPortalAccessOut;
 import com.svix.models.ApplicationTokenExpireIn;
-import com.svix.models.DashboardAccessOut;
 
 import okhttp3.Headers;
 import okhttp3.HttpUrl;
@@ -84,28 +83,19 @@ public void expireAll(
     }
 
     /**
-     * DEPRECATED: Please use `app-portal-access` instead.
-     *
-     * <p>Use this function to get magic links (and authentication codes) for connecting your users
-     * to the Consumer Application Portal.
-     *
-     * @deprecated
+     * @deprecated Please use appPortalAccess instead.
      */
     @Deprecated
-    public DashboardAccessOut dashboardAccess(final String appId) throws IOException, ApiException {
+    public com.svix.models.DashboardAccessOut dashboardAccess(final String appId)
+            throws IOException, ApiException {
         return this.dashboardAccess(appId, new AuthenticationDashboardAccessOptions());
     }
 
     /**
-     * DEPRECATED: Please use `app-portal-access` instead.
-     *
-     * <p>Use this function to get magic links (and authentication codes) for connecting your users
-     * to the Consumer Application Portal.
-     *
-     * @deprecated
+     * @deprecated Please use appPortalAccess instead.
      */
     @Deprecated
-    public DashboardAccessOut dashboardAccess(
+    public com.svix.models.DashboardAccessOut dashboardAccess(
             final String appId, final AuthenticationDashboardAccessOptions options)
             throws IOException, ApiException {
         HttpUrl.Builder url =
@@ -117,7 +107,11 @@ public DashboardAccessOut dashboardAccess(
             headers.put("idempotency-key", options.idempotencyKey);
         }
         return this.client.executeRequest(
-                "POST", url.build(), Headers.of(headers), null, DashboardAccessOut.class);
+                "POST",
+                url.build(),
+                Headers.of(headers),
+                null,
+                com.svix.models.DashboardAccessOut.class);
     }
 
     /**

java/templates/api_extra/authentication_expire_all.java

@@ -0,0 +1,23 @@
+/** @deprecated Please use appPortalAccess instead. */
+@Deprecated
+public com.svix.models.DashboardAccessOut dashboardAccess(final String appId)
+        throws IOException, ApiException {
+    return this.dashboardAccess(appId, new AuthenticationDashboardAccessOptions());
+}
+
+/** @deprecated Please use appPortalAccess instead. */
+@Deprecated
+public com.svix.models.DashboardAccessOut dashboardAccess(
+        final String appId, final AuthenticationDashboardAccessOptions options)
+        throws IOException, ApiException {
+    HttpUrl.Builder url =
+            this.client
+                    .newUrlBuilder()
+                    .encodedPath(String.format("/api/v1/auth/dashboard-access/%s", appId));
+    Map<String, String> headers = new HashMap<>();
+    if (options.idempotencyKey != null) {
+        headers.put("idempotency-key", options.idempotencyKey);
+    }
+    return this.client.executeRequest(
+            "POST", url.build(), Headers.of(headers), null, com.svix.models.DashboardAccessOut.class);
+}

javascript/src/api/authentication.ts

@@ -25,11 +25,12 @@ export interface AuthenticationExpireAllOptions {
   idempotencyKey?: string;
 }
 
-export interface AuthenticationDashboardAccessOptions {
+export interface AuthenticationLogoutOptions {
   idempotencyKey?: string;
 }
 
-export interface AuthenticationLogoutOptions {
+/** @deprecated */
+export interface AuthenticationDashboardAccessOptions {
   idempotencyKey?: string;
 }
 
@@ -74,13 +75,7 @@ export class Authentication {
     return request.sendNoResponseBody(this.requestCtx);
   }
 
-  /**
-   * DEPRECATED: Please use `app-portal-access` instead.
-   *
-   * Use this function to get magic links (and authentication codes) for connecting your users to the Consumer Application Portal.
-   *
-   * @deprecated
-   */
+  /** @deprecated Please use `appPortalAccess` instead. */
   public dashboardAccess(
     appId: string,
     options?: AuthenticationDashboardAccessOptions

javascript/src/api_internal/authentication.ts

@@ -33,6 +33,11 @@ export interface AuthenticationStreamPortalAccessOptions {
   idempotencyKey?: string;
 }
 
+/** @deprecated */
+export interface AuthenticationDashboardAccessOptions {
+  idempotencyKey?: string;
+}
+
 export class Authentication {
   public constructor(private readonly requestCtx: SvixRequestContext) {}
 

javascript/templates/api_extra/authentication_expire_all.ts

@@ -0,0 +1,15 @@
+/** @deprecated Please use `appPortalAccess` instead. */
+  public dashboardAccess(
+  appId: string,
+  options?: AuthenticationDashboardAccessOptions
+): Promise<DashboardAccessOut> {
+  const request = new SvixRequest(
+    HttpMethod.POST,
+    "/api/v1/auth/dashboard-access/{app_id}"
+  );
+
+  request.setPathParam("app_id", appId);
+  request.setHeaderParam("idempotency-key", options?.idempotencyKey);
+
+  return request.send(this.requestCtx, DashboardAccessOutSerializer._fromJsonObject);
+}