svix 2.4.0 → 2.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "svix",
-  "version": "2.4.0",
+  "version": "2.6.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/endpoint.ts

@@ -1,6 +1,10 @@
 // this file is @generated
 
 import { type BulkReplayIn, BulkReplayInSerializer } from "../models/bulkReplayIn";
+import {
+  type EndpointAttemptStats,
+  EndpointAttemptStatsSerializer,
+} from "../models/endpointAttemptStats";
 import {
   type EndpointHeadersIn,
   EndpointHeadersInSerializer,
@@ -79,6 +83,13 @@ export interface EndpointGetStatsOptions {
   until?: Date | null;
 }
 
+export interface EndpointGetAttemptStatsOptions {
+  /** Filter the range to data starting from this date. */
+  since?: Date | null;
+  /** Filter the range to data ending by this date. */
+  until?: Date | null;
+}
+
 export interface EndpointRecoverOptions {
   idempotencyKey?: string;
 }
@@ -394,6 +405,34 @@ export class Endpoint {
     return await request.send(this.requestCtx, EndpointStatsSerializer._fromJsonObject);
   }
 
+  /**
+   * Get basic statistics about attempted deliveries for the endpoint.
+   *
+   * Time windows are always rounded to hour granularity
+   */
+  public async getAttemptStats(
+    appId: string,
+    endpointId: string,
+    options?: EndpointGetAttemptStatsOptions
+  ): Promise<EndpointAttemptStats> {
+    const request = new SvixRequest(
+      HttpMethod.GET,
+      "/api/v1/app/{app_id}/endpoint/{endpoint_id}/attempt-stats"
+    );
+
+    request.setPathParam("app_id", appId);
+    request.setPathParam("endpoint_id", endpointId);
+    request.setQueryParams({
+      since: options?.since,
+      until: options?.until,
+    });
+
+    return await request.send(
+      this.requestCtx,
+      EndpointAttemptStatsSerializer._fromJsonObject
+    );
+  }
+
   /**
    * Resend all failed messages since a given time.
    *

package/src/api/eventType.ts

@@ -44,7 +44,10 @@ export interface EventTypeImportOpenapiOptions {
 }
 
 export interface EventTypeDeleteOptions {
-  /** By default event types are archived when "deleted". Passing this to `true` deletes them entirely. */
+  /**
+   * By default event types are archived when "deleted". Passing this to `true` deletes them
+   * entirely.
+   */
   expunge?: boolean;
 }
 

package/src/api/message.ts

@@ -43,7 +43,8 @@ export interface MessageListOptions {
   /**
    * When `true` message payloads are included in the response.
    *
-   * Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request without specifying this parameter.
+   * Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request
+   * without specifying this parameter.
    */
   withContent?: boolean;
   /** Filter messages matching the provided tag. */
@@ -56,7 +57,8 @@ export interface MessageCreateOptions {
   /**
    * When `true`, message payloads are included in the response.
    *
-   * Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request without specifying this parameter.
+   * Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request
+   * without specifying this parameter.
    */
   withContent?: boolean;
   idempotencyKey?: string;
@@ -70,7 +72,8 @@ export interface MessageGetOptions {
   /**
    * When `true` message payloads are included in the response.
    *
-   * Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request without specifying this parameter.
+   * Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request
+   * without specifying this parameter.
    */
   withContent?: boolean;
 }

package/src/api/messageAttempt.ts

@@ -41,7 +41,8 @@ export interface MessageAttemptListByEndpointOptions {
   /**
    * When `true` attempt content is included in the response.
    *
-   * Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request without specifying this parameter.
+   * Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request
+   * without specifying this parameter.
    */
   withContent?: boolean;
   /**
@@ -82,7 +83,8 @@ export interface MessageAttemptListByMsgOptions {
   /**
    * When `true` attempt content is included in the response.
    *
-   * Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request without specifying this parameter.
+   * Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request
+   * without specifying this parameter.
    */
   withContent?: boolean;
   /**
@@ -113,7 +115,8 @@ export interface MessageAttemptListAttemptedMessagesOptions {
   /**
    * When `true` message payloads are included in the response.
    *
-   * Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request without specifying this parameter.
+   * Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request
+   * without specifying this parameter.
    */
   withContent?: boolean;
   /**

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/appPortalAccessIn.ts

@@ -43,13 +43,15 @@ export interface AppPortalAccessIn {
   /**
    * How long the token will be valid for, in seconds.
    *
-   * Valid values are between 1 hour and 7 days. The default is 7 days.
+   * Valid values are between 1 hour and 7 days.
+   * The default is 7 days.
    */
   expiry?: number | null;
   /**
    * An optional session ID to attach to the token.
    *
-   * When expiring tokens with "Expire All", you can include the session ID to only expire tokens that were created with that session ID.
+   * When expiring tokens with "Expire All", you can include the session ID
+   * to only expire tokens that were created with that session ID.
    */
   sessionId?: string | null;
 }

package/src/models/appUsageStatsOut.ts

@@ -9,37 +9,37 @@ import {
 } from "./backgroundTaskType";
 
 export interface AppUsageStatsOut {
+  /** The QueueBackgroundTask's ID. */
+  id: string;
+  status: BackgroundTaskStatus;
+  task: BackgroundTaskType;
+  updatedAt: Date;
   /**
    * Any app IDs or UIDs received in the request that weren't found.
    *
    * Stats will be produced for all the others.
    */
   unresolvedAppIds: string[];
-  /** The QueueBackgroundTask's ID. */
-  id: string;
-  status: BackgroundTaskStatus;
-  task: BackgroundTaskType;
-  updatedAt: Date;
 }
 
 export const AppUsageStatsOutSerializer = {
   _fromJsonObject(object: any): AppUsageStatsOut {
     return {
-      unresolvedAppIds: object["unresolvedAppIds"],
       id: object["id"],
       status: BackgroundTaskStatusSerializer._fromJsonObject(object["status"]),
       task: BackgroundTaskTypeSerializer._fromJsonObject(object["task"]),
       updatedAt: new Date(object["updatedAt"]),
+      unresolvedAppIds: object["unresolvedAppIds"],
     };
   },
 
   _toJsonObject(self: AppUsageStatsOut): any {
     return {
-      unresolvedAppIds: self.unresolvedAppIds,
       id: self.id,
       status: BackgroundTaskStatusSerializer._toJsonObject(self.status),
       task: BackgroundTaskTypeSerializer._toJsonObject(self.task),
       updatedAt: self.updatedAt,
+      unresolvedAppIds: self.unresolvedAppIds,
     };
   },
 };

package/src/models/applicationTokenExpireIn.ts

@@ -6,7 +6,8 @@ export interface ApplicationTokenExpireIn {
   /**
    * An optional list of session ids.
    *
-   * If any session ids are specified, only Application tokens created with that session id will be expired.
+   * If any session ids are specified, only Application tokens created with that
+   * session id will be expired.
    */
   sessionIds?: string[];
 }

package/src/models/autoConfigOut.ts

@@ -0,0 +1,27 @@
+// this file is @generated
+
+export interface AutoConfigOut {
+  createdAt: Date;
+  /** The AutoConfig token */
+  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/autoConfigSubscriptionOut.ts

@@ -3,6 +3,7 @@ import { type Status, StatusSerializer } from "./status";
 
 export interface AutoConfigSubscriptionOut {
   createdAt: Date;
+  /** The censored AutoConfig token */
   tokenCensored: string;
   /** The AutoConfigSubscription's ID. */
   id: string;

package/src/models/azureBlobStorageConfigIn.ts

@@ -6,7 +6,8 @@ export interface AzureBlobStorageConfigIn {
   /**
    * Access key.
    *
-   * Currently a required field, but marked as optional because we may add different authentication in the future.
+   * Currently a required field, but marked as optional because we may add
+   * different authentication in the future.
    */
   accessKey?: string | null;
 }

package/src/models/clickhouseConfigIn.ts

@@ -6,13 +6,15 @@ export interface ClickhouseConfigIn {
   /**
    * Username to access Clickhouse.
    *
-   * Currently a required field, but marked as optional because we may add different authentication in the future.
+   * Currently a required field, but marked as optional because we may add
+   * different authentication in the future.
    */
   username?: string | null;
   /**
    * Password to access Clickhouse.
    *
-   * Currently a required field, but marked as optional because we may add different authentication in the future.
+   * Currently a required field, but marked as optional because we may add
+   * different authentication in the future.
    */
   password?: string | null;
   /** The Clickhouse database to connect to. */

package/src/models/createStreamEventsIn.ts

@@ -7,7 +7,8 @@ export interface CreateStreamEventsIn {
   /**
    * Optionally creates a new Stream alongside the events.
    *
-   * If the stream id or uid that is used in the path already exists, this argument is ignored.
+   * If the stream id or uid that is used in the path already exists,
+   * this argument is ignored.
    */
   stream?: StreamIn | null;
 }

package/src/models/destinationIn.ts

@@ -46,9 +46,11 @@ interface _DestinationInFields {
   /**
    * Whether the destination will receive events.
    *
-   * If the destination is `enabled`, events sent to the application will be dispatched to the destination in order.
+   * If the destination is `enabled`, events sent to the application will be
+   * dispatched to the destination in order.
    *
-   * If the destination is `disabled`, events will not be dispatched until the destination is reenabled.
+   * If the destination is `disabled`, events will not be dispatched until the
+   * destination is reenabled.
    */
   status?: DestinationStatusIn;
   /** How many events will be batched in a request to the destination. */
@@ -56,14 +58,21 @@ interface _DestinationInFields {
   /**
    * How long to wait before a batch of events is sent, if the `batchSize` is not reached.
    *
-   * For example, with a `batchSize` of 100 and `maxWaitSecs` of 10, a request is sent after 10 seconds or 100 events, whichever comes first.
+   * For example, with a `batchSize` of 100 and `maxWaitSecs` of 10, a request is sent after
+   * 10 seconds or 100 events, whichever comes first.
    *
    * Note that an empty batch is never sent to the destination.
    */
   maxWaitSecs?: number;
-  /** A list of event types that filter which events are dispatched to the destination. An empty list (or null) will not filter out any events. */
+  /**
+   * A list of event types that filter which events are dispatched to the destination.
+   * An empty list (or null) will not filter out any events.
+   */
   eventTypes?: string[];
-  /** A list of channels that filter which events are dispatched to the destination. An empty list (or null) will not filter out any events. */
+  /**
+   * A list of channels that filter which events are dispatched to the destination.
+   * An empty list (or null) will not filter out any events.
+   */
   channels?: string[];
   metadata?: { [key: string]: string };
 }

package/src/models/endpointAttemptStats.ts

@@ -0,0 +1,25 @@
+// this file is @generated
+
+export interface EndpointAttemptStats {
+  success: number;
+  fail: number;
+  canceled: number;
+}
+
+export const EndpointAttemptStatsSerializer = {
+  _fromJsonObject(object: any): EndpointAttemptStats {
+    return {
+      success: object["success"],
+      fail: object["fail"],
+      canceled: object["canceled"],
+    };
+  },
+
+  _toJsonObject(self: EndpointAttemptStats): any {
+    return {
+      success: self.success,
+      fail: self.fail,
+      canceled: self.canceled,
+    };
+  },
+};

package/src/models/endpointMessageOut.ts

@@ -2,7 +2,10 @@
 import { type MessageStatus, MessageStatusSerializer } from "./messageStatus";
 import { type MessageStatusText, MessageStatusTextSerializer } from "./messageStatusText";
 
-/** A model containing information on a given message plus additional fields on the last attempt for that message. */
+/**
+ * A model containing information on a given message plus additional fields on the last attempt for
+ * that message.
+ */
 export interface EndpointMessageOut {
   status: MessageStatus;
   statusText: MessageStatusText;

package/src/models/endpointSecretRotateIn.ts

@@ -11,7 +11,8 @@ export interface EndpointSecretRotateIn {
   /**
    * How long the old secret will be valid for, in seconds.
    *
-   * Valid values are between 0 (immediate expiry) and 7 days. The default is 24 hours.
+   * Valid values are between 0 (immediate expiry) and 7 days.
+   * The default is 24 hours.
    */
   gracePeriodSeconds?: number | null;
 }

package/src/models/eventBridgeConfigIn.ts

@@ -8,19 +8,28 @@ 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.
    *
-   * Currently a required field, but marked as optional because we may infer it from other fields in the future.
+   * Currently a required field, but marked as optional because we may infer
+   * it from other fields in the future.
    */
   region?: string | null;
 }
@@ -32,6 +41,8 @@ export const EventBridgeConfigInSerializer = {
       detailType: object["detailType"],
       accessKeyId: object["accessKeyId"],
       secretAccessKey: object["secretAccessKey"],
+      roleArn: object["roleArn"],
+      externalId: object["externalId"],
       region: object["region"],
     };
   },
@@ -42,6 +53,8 @@ export const EventBridgeConfigInSerializer = {
       detailType: self.detailType,
       accessKeyId: self.accessKeyId,
       secretAccessKey: self.secretAccessKey,
+      roleArn: self.roleArn,
+      externalId: self.externalId,
       region: self.region,
     };
   },