svix 2.4.0 → 2.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "svix",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "description": "Svix webhooks API client and webhook verification library",
   "author": "svix",
   "repository": "https://github.com/svix/svix-webhooks",

package/src/api/autoconfigSubscription.ts

@@ -0,0 +1,53 @@
+// this file is @generated
+
+import { type AutoConfigOut, AutoConfigOutSerializer } from "../models/autoConfigOut";
+import {
+  type RotateSubscriptionIn2,
+  RotateSubscriptionIn2Serializer,
+} from "../models/rotateSubscriptionIn2";
+import { HttpMethod, SvixRequest, type SvixRequestContext } from "../request";
+
+export interface AutoconfigSubscriptionCreateOptions {
+  idempotencyKey?: string;
+}
+
+export interface AutoconfigSubscriptionRotateOptions {
+  idempotencyKey?: string;
+}
+
+export class AutoconfigSubscription {
+  public constructor(private readonly requestCtx: SvixRequestContext) {}
+
+  /** Create an AutoConfig subscription. */
+  public async create(
+    appId: string,
+    options?: AutoconfigSubscriptionCreateOptions
+  ): Promise<AutoConfigOut> {
+    const request = new SvixRequest(HttpMethod.POST, "/api/v1/app/{app_id}/autoconfig");
+
+    request.setPathParam("app_id", appId);
+    request.setHeaderParam("idempotency-key", options?.idempotencyKey);
+
+    return await request.send(this.requestCtx, AutoConfigOutSerializer._fromJsonObject);
+  }
+
+  /** Rotate the auth token and signing secret for an AutoConfig subscription. */
+  public async rotate(
+    appId: string,
+    autoconfigId: string,
+    rotateSubscriptionIn2: RotateSubscriptionIn2 = {},
+    options?: AutoconfigSubscriptionRotateOptions
+  ): Promise<AutoConfigOut> {
+    const request = new SvixRequest(
+      HttpMethod.POST,
+      "/api/v1/app/{app_id}/autoconfig/{autoconfig_id}/rotate"
+    );
+
+    request.setPathParam("app_id", appId);
+    request.setPathParam("autoconfig_id", autoconfigId);
+    request.setHeaderParam("idempotency-key", options?.idempotencyKey);
+    request.setBody(RotateSubscriptionIn2Serializer._toJsonObject(rotateSubscriptionIn2));
+
+    return await request.send(this.requestCtx, AutoConfigOutSerializer._fromJsonObject);
+  }
+}

package/src/api_internal/autoconfigSubscription.ts

@@ -0,0 +1,40 @@
+// this file is @generated
+
+import {
+  type AutoConfigSubscriptionOut,
+  AutoConfigSubscriptionOutSerializer,
+} from "../models/autoConfigSubscriptionOut";
+import { AutoconfigSubscriptionDestination } from "./autoconfigSubscriptionDestination";
+import { AutoconfigSubscriptionEndpoint } from "./autoconfigSubscriptionEndpoint";
+import { HttpMethod, SvixRequest, type SvixRequestContext } from "../request";
+
+export class AutoconfigSubscription {
+  public constructor(private readonly requestCtx: SvixRequestContext) {}
+
+  public get destination() {
+    return new AutoconfigSubscriptionDestination(this.requestCtx);
+  }
+
+  public get endpoint() {
+    return new AutoconfigSubscriptionEndpoint(this.requestCtx);
+  }
+
+  /** Get an AutoConfig subscription, including the bound endpoint or destination if any. */
+  public async get(
+    appId: string,
+    autoconfigId: string
+  ): Promise<AutoConfigSubscriptionOut> {
+    const request = new SvixRequest(
+      HttpMethod.GET,
+      "/api/v1/app/{app_id}/autoconfig/{autoconfig_id}"
+    );
+
+    request.setPathParam("app_id", appId);
+    request.setPathParam("autoconfig_id", autoconfigId);
+
+    return await request.send(
+      this.requestCtx,
+      AutoConfigSubscriptionOutSerializer._fromJsonObject
+    );
+  }
+}

package/src/api_internal/{destinationAutoconfig.ts → autoconfigSubscriptionDestination.ts}

@@ -4,7 +4,7 @@ import { type DestinationIn, DestinationInSerializer } from "../models/destinati
 import { type DestinationOut, DestinationOutSerializer } from "../models/destinationOut";
 import { HttpMethod, SvixRequest, type SvixRequestContext } from "../request";
 
-export class DestinationAutoconfig {
+export class AutoconfigSubscriptionDestination {
   public constructor(private readonly requestCtx: SvixRequestContext) {}
 
   /** Create or update the destination for an AutoConfig subscription. */

package/src/api_internal/{endpointAutoconfig.ts → autoconfigSubscriptionEndpoint.ts}

@@ -1,35 +1,12 @@
 // this file is @generated
 
-import {
-  type AutoConfigSubscriptionOut,
-  AutoConfigSubscriptionOutSerializer,
-} from "../models/autoConfigSubscriptionOut";
 import { type EndpointIn, EndpointInSerializer } from "../models/endpointIn";
 import { type EndpointOut, EndpointOutSerializer } from "../models/endpointOut";
 import { HttpMethod, SvixRequest, type SvixRequestContext } from "../request";
 
-export class EndpointAutoconfig {
+export class AutoconfigSubscriptionEndpoint {
   public constructor(private readonly requestCtx: SvixRequestContext) {}
 
-  /** Get an AutoConfig subscription, including the bound endpoint or destination if any. */
-  public async get(
-    appId: string,
-    autoconfigId: string
-  ): Promise<AutoConfigSubscriptionOut> {
-    const request = new SvixRequest(
-      HttpMethod.GET,
-      "/api/v1/app/{app_id}/autoconfig/{autoconfig_id}"
-    );
-
-    request.setPathParam("app_id", appId);
-    request.setPathParam("autoconfig_id", autoconfigId);
-
-    return await request.send(
-      this.requestCtx,
-      AutoConfigSubscriptionOutSerializer._fromJsonObject
-    );
-  }
-
   /** Create or update the HTTP endpoint for an AutoConfig subscription. */
   public async subscribe(
     appId: string,

package/src/api_internal/endpoint.ts

@@ -5,7 +5,6 @@ import {
   EndpointTransformationInSerializer,
 } from "../models/endpointTransformationIn";
 import { EndpointAutoConfigDeprecated } from "./endpointAutoConfigDeprecated";
-import { EndpointAutoconfig } from "./endpointAutoconfig";
 import { HttpMethod, SvixRequest, type SvixRequestContext } from "../request";
 
 export class Endpoint {
@@ -15,10 +14,6 @@ export class Endpoint {
     return new EndpointAutoConfigDeprecated(this.requestCtx);
   }
 
-  public get autoconfig() {
-    return new EndpointAutoconfig(this.requestCtx);
-  }
-
   /**
    * This operation was renamed to `set-transformation`.
    *

package/src/autoconfig.ts

@@ -1,4 +1,5 @@
 import { SvixInternal } from "./api_internal";
+import { AutoconfigSubscription } from "./api_internal/autoconfigSubscription";
 import { Endpoint as InternalEndpoint } from "./api_internal/endpoint";
 import type { EndpointIn } from "./models/endpointIn";
 import type { EndpointOut } from "./models/endpointOut";
@@ -157,7 +158,7 @@ export class AutoConfig {
   public subscribe(): Promise<EndpointOut> {
     const endpoint = new InternalEndpoint(this.requestCtx);
     if (this.autoconfigId != null) {
-      return endpoint.autoconfig.subscribe(
+      return new AutoconfigSubscription(this.requestCtx).endpoint.subscribe(
         this.appId,
         this.autoconfigId,
         this.endpointIn

package/src/autoconfigConsumer.ts

@@ -1,5 +1,5 @@
 import { SvixInternal } from "./api_internal";
-import { Destination as InternalDestination } from "./api_internal/destination";
+import { AutoconfigSubscription } from "./api_internal/autoconfigSubscription";
 import { Endpoint as InternalEndpoint } from "./api_internal/endpoint";
 import {
   MessagePollerv2 as InternalMessagePollerv2,
@@ -44,9 +44,9 @@ export class AutoConfigConsumer {
     const endpoint = new InternalEndpoint(this.requestCtx);
     if (this.autoconfigId != null) {
       // v2
-      const destination = await new InternalDestination(
+      const destination = await new AutoconfigSubscription(
         this.requestCtx
-      ).autoconfig.subscribe(
+      ).destination.subscribe(
         this.appId,
         this.autoconfigId,
         sinkInCommonToPollingDestination(this.sinkIn)
@@ -74,7 +74,7 @@ export class AutoConfigConsumer {
 
     // Get the sink id from the autoconfig id (v2)
     const destId = (
-      await new InternalEndpoint(this.requestCtx).autoconfig.get(
+      await new AutoconfigSubscription(this.requestCtx).get(
         this.appId,
         this.autoconfigId as string
       )

package/src/index.ts

@@ -1,6 +1,7 @@
 // this file is @generated
 import { Application } from "./api/application";
 import { Authentication } from "./api/authentication";
+import { AutoconfigSubscription } from "./api/autoconfigSubscription";
 import { BackgroundTask } from "./api/backgroundTask";
 import { Connector } from "./api/connector";
 import { Destination } from "./api/destination";
@@ -70,6 +71,10 @@ export class Svix {
     return new Authentication(this.requestCtx);
   }
 
+  public get autoconfigSubscription() {
+    return new AutoconfigSubscription(this.requestCtx);
+  }
+
   public get backgroundTask() {
     return new BackgroundTask(this.requestCtx);
   }

package/src/models/autoConfigOut.ts

@@ -0,0 +1,26 @@
+// this file is @generated
+
+export interface AutoConfigOut {
+  createdAt: Date;
+  token: string;
+  /** The AutoConfigSubscription's ID. */
+  id: string;
+}
+
+export const AutoConfigOutSerializer = {
+  _fromJsonObject(object: any): AutoConfigOut {
+    return {
+      createdAt: new Date(object["createdAt"]),
+      token: object["token"],
+      id: object["id"],
+    };
+  },
+
+  _toJsonObject(self: AutoConfigOut): any {
+    return {
+      createdAt: self.createdAt,
+      token: self.token,
+      id: self.id,
+    };
+  },
+};

package/src/models/eventBridgeConfigIn.ts

@@ -8,15 +8,23 @@ export interface EventBridgeConfigIn {
   /**
    * Access key ID.
    *
-   * Currently a required field, but marked as optional because we may add different authentication in the future.
+   * Required (along with `secret_access_key`) if `role_arn` is blank.
    */
   accessKeyId?: string | null;
   /**
    * Secret access key.
    *
-   * Currently a required field, but marked as optional because we may add different authentication in the future.
+   * Required (along with `access_key_id`) if `role_arn` is blank.
    */
   secretAccessKey?: string | null;
+  /** Role ARN for delegated authentication */
+  roleArn?: string | null;
+  /**
+   * Shared secret passed as the STS ExternalId.
+   *
+   * Can only be set if `role_arn` is Some
+   */
+  externalId?: string | null;
   /**
    * The region of the EventBridge bus.
    *
@@ -32,6 +40,8 @@ export const EventBridgeConfigInSerializer = {
       detailType: object["detailType"],
       accessKeyId: object["accessKeyId"],
       secretAccessKey: object["secretAccessKey"],
+      roleArn: object["roleArn"],
+      externalId: object["externalId"],
       region: object["region"],
     };
   },
@@ -42,6 +52,8 @@ export const EventBridgeConfigInSerializer = {
       detailType: self.detailType,
       accessKeyId: self.accessKeyId,
       secretAccessKey: self.secretAccessKey,
+      roleArn: self.roleArn,
+      externalId: self.externalId,
       region: self.region,
     };
   },

package/src/models/eventBridgeConfigOut.ts

@@ -3,7 +3,9 @@
 export interface EventBridgeConfigOut {
   eventBusName: string;
   detailType: string;
-  accessKeyId: string;
+  accessKeyId?: string | null;
+  roleArn?: string | null;
+  externalId?: string | null;
   region: string;
 }
 
@@ -13,6 +15,8 @@ export const EventBridgeConfigOutSerializer = {
       eventBusName: object["eventBusName"],
       detailType: object["detailType"],
       accessKeyId: object["accessKeyId"],
+      roleArn: object["roleArn"],
+      externalId: object["externalId"],
       region: object["region"],
     };
   },
@@ -22,6 +26,8 @@ export const EventBridgeConfigOutSerializer = {
       eventBusName: self.eventBusName,
       detailType: self.detailType,
       accessKeyId: self.accessKeyId,
+      roleArn: self.roleArn,
+      externalId: self.externalId,
       region: self.region,
     };
   },

package/src/models/eventBridgeConfigPatch.ts

@@ -5,6 +5,8 @@ export interface EventBridgeConfigPatch {
   detailType?: string;
   accessKeyId?: string;
   secretAccessKey?: string;
+  roleArn?: string;
+  externalId?: string;
   region?: string;
 }
 
@@ -15,6 +17,8 @@ export const EventBridgeConfigPatchSerializer = {
       detailType: object["detailType"],
       accessKeyId: object["accessKeyId"],
       secretAccessKey: object["secretAccessKey"],
+      roleArn: object["roleArn"],
+      externalId: object["externalId"],
       region: object["region"],
     };
   },
@@ -25,6 +29,8 @@ export const EventBridgeConfigPatchSerializer = {
       detailType: self.detailType,
       accessKeyId: self.accessKeyId,
       secretAccessKey: self.secretAccessKey,
+      roleArn: self.roleArn,
+      externalId: self.externalId,
       region: self.region,
     };
   },

package/src/models/index.ts

@@ -14,6 +14,7 @@ export { type ApplicationIn } from "./applicationIn";
 export { type ApplicationOut } from "./applicationOut";
 export { type ApplicationPatch } from "./applicationPatch";
 export { type ApplicationTokenExpireIn } from "./applicationTokenExpireIn";
+export { type AutoConfigOut } from "./autoConfigOut";
 export { type AzureBlobStorageConfigIn } from "./azureBlobStorageConfigIn";
 export { type AzureBlobStorageConfigOut } from "./azureBlobStorageConfigOut";
 export { type AzureBlobStorageConfigPatch } from "./azureBlobStorageConfigPatch";
@@ -182,6 +183,7 @@ export { type RedshiftConfigPatch } from "./redshiftConfigPatch";
 export { type ReplayIn } from "./replayIn";
 export { type ReplayOut } from "./replayOut";
 export { type RotatePollerTokenIn } from "./rotatePollerTokenIn";
+export { type RotateSubscriptionIn2 } from "./rotateSubscriptionIn2";
 export { type RotateTokenOut } from "./rotateTokenOut";
 export { type RutterConfig } from "./rutterConfig";
 export { type RutterConfigOut } from "./rutterConfigOut";

package/src/models/redshiftConfigIn.ts

@@ -9,15 +9,23 @@ export interface RedshiftConfigIn {
   /**
    * Access key ID.
    *
-   * Currently a required field, but marked as optional because we may add different authentication in the future.
+   * Required (along with `secret_access_key`) if `role_arn` is blank.
    */
   accessKeyId?: string | null;
   /**
    * Secret access key.
    *
-   * Currently a required field, but marked as optional because we may add different authentication in the future.
+   * Required (along with `access_key_id`) if `role_arn` is blank.
    */
   secretAccessKey?: string | null;
+  /** Role ARN for delegated authentication */
+  roleArn?: string | null;
+  /**
+   * Shared secret passed as the STS ExternalId.
+   *
+   * Can only be set if `role_arn` is Some
+   */
+  externalId?: string | null;
   /**
    * The region of the Redshift DB.
    *
@@ -55,6 +63,8 @@ export const RedshiftConfigInSerializer = {
     return {
       accessKeyId: object["accessKeyId"],
       secretAccessKey: object["secretAccessKey"],
+      roleArn: object["roleArn"],
+      externalId: object["externalId"],
       region: object["region"],
       clusterIdentifier: object["clusterIdentifier"],
       dbUser: object["dbUser"],
@@ -69,6 +79,8 @@ export const RedshiftConfigInSerializer = {
     return {
       accessKeyId: self.accessKeyId,
       secretAccessKey: self.secretAccessKey,
+      roleArn: self.roleArn,
+      externalId: self.externalId,
       region: self.region,
       clusterIdentifier: self.clusterIdentifier,
       dbUser: self.dbUser,

package/src/models/redshiftConfigOut.ts

@@ -1,7 +1,9 @@
 // this file is @generated
 
 export interface RedshiftConfigOut {
-  accessKeyId: string;
+  accessKeyId?: string | null;
+  roleArn?: string | null;
+  externalId?: string | null;
   region: string;
   clusterIdentifier?: string | null;
   dbUser?: string | null;
@@ -30,6 +32,8 @@ export const RedshiftConfigOutSerializer = {
   _fromJsonObject(object: any): RedshiftConfigOut {
     return {
       accessKeyId: object["accessKeyId"],
+      roleArn: object["roleArn"],
+      externalId: object["externalId"],
       region: object["region"],
       clusterIdentifier: object["clusterIdentifier"],
       dbUser: object["dbUser"],
@@ -43,6 +47,8 @@ export const RedshiftConfigOutSerializer = {
   _toJsonObject(self: RedshiftConfigOut): any {
     return {
       accessKeyId: self.accessKeyId,
+      roleArn: self.roleArn,
+      externalId: self.externalId,
       region: self.region,
       clusterIdentifier: self.clusterIdentifier,
       dbUser: self.dbUser,

package/src/models/redshiftConfigPatch.ts

@@ -3,6 +3,8 @@
 export interface RedshiftConfigPatch {
   accessKeyId?: string;
   secretAccessKey?: string;
+  roleArn?: string;
+  externalId?: string;
   region?: string;
   /**
    * Database name.
@@ -29,6 +31,8 @@ export const RedshiftConfigPatchSerializer = {
     return {
       accessKeyId: object["accessKeyId"],
       secretAccessKey: object["secretAccessKey"],
+      roleArn: object["roleArn"],
+      externalId: object["externalId"],
       region: object["region"],
       dbName: object["dbName"],
       schemaName: object["schemaName"],
@@ -40,6 +44,8 @@ export const RedshiftConfigPatchSerializer = {
     return {
       accessKeyId: self.accessKeyId,
       secretAccessKey: self.secretAccessKey,
+      roleArn: self.roleArn,
+      externalId: self.externalId,
       region: self.region,
       dbName: self.dbName,
       schemaName: self.schemaName,

package/src/models/rotateSubscriptionIn2.ts

@@ -0,0 +1,29 @@
+// this file is @generated
+import {
+  type EndpointSecretRotateIn,
+  EndpointSecretRotateInSerializer,
+} from "./endpointSecretRotateIn";
+
+export interface RotateSubscriptionIn2 {
+  signingSecret?: EndpointSecretRotateIn | null;
+}
+
+export const RotateSubscriptionIn2Serializer = {
+  _fromJsonObject(object: any): RotateSubscriptionIn2 {
+    return {
+      signingSecret:
+        object["signingSecret"] != null
+          ? EndpointSecretRotateInSerializer._fromJsonObject(object["signingSecret"])
+          : undefined,
+    };
+  },
+
+  _toJsonObject(self: RotateSubscriptionIn2): any {
+    return {
+      signingSecret:
+        self.signingSecret != null
+          ? EndpointSecretRotateInSerializer._toJsonObject(self.signingSecret)
+          : undefined,
+    };
+  },
+};

package/src/models/snsConfigIn.ts

@@ -12,16 +12,24 @@ export interface SnsConfigIn {
   /**
    * Access key ID.
    *
-   * Currently a required field, but marked as optional because we may add different authentication in the future.
+   * Required (along with `secret_access_key`) if `role_arn` is None
    */
   accessKeyId?: string | null;
   /**
    * Secret access key.
    *
-   * Currently a required field, but marked as optional because we may add different authentication in the future.
+   * Required (along with `access_key_id`) if `role_arn` is None
    */
   secretAccessKey?: string | null;
   endpointUrl?: string | null;
+  /** Role ARN for delegated authentication */
+  roleArn?: string | null;
+  /**
+   * Shared secret passed as the STS ExternalId.
+   *
+   * Can only be set if `role_arn` is Some
+   */
+  externalId?: string | null;
 }
 
 export const SnsConfigInSerializer = {
@@ -32,6 +40,8 @@ export const SnsConfigInSerializer = {
       accessKeyId: object["accessKeyId"],
       secretAccessKey: object["secretAccessKey"],
       endpointUrl: object["endpointUrl"],
+      roleArn: object["roleArn"],
+      externalId: object["externalId"],
     };
   },
 
@@ -42,6 +52,8 @@ export const SnsConfigInSerializer = {
       accessKeyId: self.accessKeyId,
       secretAccessKey: self.secretAccessKey,
       endpointUrl: self.endpointUrl,
+      roleArn: self.roleArn,
+      externalId: self.externalId,
     };
   },
 };

package/src/models/snsConfigOut.ts

@@ -3,7 +3,9 @@
 export interface SnsConfigOut {
   topicArn: string;
   region: string;
-  accessKeyId: string;
+  accessKeyId?: string | null;
+  roleArn?: string | null;
+  externalId?: string | null;
 }
 
 export const SnsConfigOutSerializer = {
@@ -12,6 +14,8 @@ export const SnsConfigOutSerializer = {
       topicArn: object["topicArn"],
       region: object["region"],
       accessKeyId: object["accessKeyId"],
+      roleArn: object["roleArn"],
+      externalId: object["externalId"],
     };
   },
 
@@ -20,6 +24,8 @@ export const SnsConfigOutSerializer = {
       topicArn: self.topicArn,
       region: self.region,
       accessKeyId: self.accessKeyId,
+      roleArn: self.roleArn,
+      externalId: self.externalId,
     };
   },
 };

package/src/models/snsConfigPatch.ts

@@ -5,6 +5,8 @@ export interface SnsConfigPatch {
   region?: string;
   accessKeyId?: string;
   secretAccessKey?: string;
+  roleArn?: string;
+  externalId?: string;
   endpointUrl?: string | null;
 }
 
@@ -15,6 +17,8 @@ export const SnsConfigPatchSerializer = {
       region: object["region"],
       accessKeyId: object["accessKeyId"],
       secretAccessKey: object["secretAccessKey"],
+      roleArn: object["roleArn"],
+      externalId: object["externalId"],
       endpointUrl: object["endpointUrl"],
     };
   },
@@ -25,6 +29,8 @@ export const SnsConfigPatchSerializer = {
       region: self.region,
       accessKeyId: self.accessKeyId,
       secretAccessKey: self.secretAccessKey,
+      roleArn: self.roleArn,
+      externalId: self.externalId,
       endpointUrl: self.endpointUrl,
     };
   },

package/src/models/sqsConfigIn.ts

@@ -12,15 +12,23 @@ export interface SqsConfigIn {
   /**
    * Access key ID.
    *
-   * Currently a required field, but marked as optional because we may add different authentication in the future.
+   * Required (along with `secret_access_key`) if `role_arn` is blank.
    */
   accessKeyId?: string | null;
   /**
    * Secret access key.
    *
-   * Currently a required field, but marked as optional because we may add different authentication in the future.
+   * Required (along with `access_key_id`) if `role_arn` is blank.
    */
   secretAccessKey?: string | null;
+  /** Role ARN for delegated authentication */
+  roleArn?: string | null;
+  /**
+   * Shared secret passed as the STS ExternalId.
+   *
+   * Can only be set if `role_arn` is Some
+   */
+  externalId?: string | null;
   endpointUrl?: string | null;
 }
 
@@ -31,6 +39,8 @@ export const SqsConfigInSerializer = {
       region: object["region"],
       accessKeyId: object["accessKeyId"],
       secretAccessKey: object["secretAccessKey"],
+      roleArn: object["roleArn"],
+      externalId: object["externalId"],
       endpointUrl: object["endpointUrl"],
     };
   },
@@ -41,6 +51,8 @@ export const SqsConfigInSerializer = {
       region: self.region,
       accessKeyId: self.accessKeyId,
       secretAccessKey: self.secretAccessKey,
+      roleArn: self.roleArn,
+      externalId: self.externalId,
       endpointUrl: self.endpointUrl,
     };
   },