svix 2.5.0 → 2.6.0

package/package.json

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

@@ -2,6 +2,7 @@
 
 export interface AutoConfigOut {
   createdAt: Date;
+  /** The AutoConfig token */
   token: string;
   /** The AutoConfigSubscription's ID. */
   id: string;

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

@@ -28,7 +28,8 @@ export interface EventBridgeConfigIn {
   /**
    * 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;
 }

package/src/models/eventTypeImportOpenApiIn.ts

@@ -3,7 +3,9 @@
 /**
  * Import a list of event types from webhooks defined in an OpenAPI spec.
  *
- * The OpenAPI spec can be specified as either `spec` given the spec as a JSON object, or as `specRaw` (a `string`) which will be parsed as YAML or JSON by the server. Sending neither or both is invalid, resulting in a `400` **Bad Request**.
+ * The OpenAPI spec can be specified as either `spec` given the spec as a JSON object, or as `specRaw`
+ * (a `string`) which will be parsed as YAML or JSON by the server.
+ * Sending neither or both is invalid, resulting in a `400` **Bad Request**.
  */
 export interface EventTypeImportOpenApiIn {
   /** If `true`, return the event types that would be modified without actually modifying them. */

package/src/models/index.ts

@@ -54,6 +54,7 @@ export { type DocusignConfigOut } from "./docusignConfigOut";
 export { type EasypostConfig } from "./easypostConfig";
 export { type EasypostConfigOut } from "./easypostConfigOut";
 export { type EmptyResponse } from "./emptyResponse";
+export { type EndpointAttemptStats } from "./endpointAttemptStats";
 export { type EndpointHeadersIn } from "./endpointHeadersIn";
 export { type EndpointHeadersOut } from "./endpointHeadersOut";
 export { type EndpointHeadersPatchIn } from "./endpointHeadersPatchIn";

package/src/models/ingestEndpointSecretIn.ts

@@ -11,7 +11,8 @@ export interface IngestEndpointSecretIn {
   /**
    * 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/ingestSourceConsumerPortalAccessIn.ts

@@ -4,7 +4,8 @@ export interface IngestSourceConsumerPortalAccessIn {
   /**
    * 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;
   /** Whether the app portal should be in read-only mode. */

package/src/models/messageIn.ts

@@ -17,7 +17,8 @@ export interface MessageIn {
   /**
    * Optionally creates a new application alongside the message.
    *
-   * If the application id or uid that is used in the path already exists, this argument is ignored.
+   * If the application id or uid that is used in the path already exists,
+   * this argument is ignored.
    */
   application?: ApplicationIn | null;
   /** List of free-form tags that can be filtered by when listing messages */
@@ -27,12 +28,19 @@ export interface MessageIn {
   /**
    * The date and time at which the message will be delivered.
    *
-   * Note that this time is best-effort-only. Must be at least one minute and no more than 24 hours in the future.
+   * Note that this time is best-effort-only. Must be at least one minute
+   * and no more than 24 hours in the future.
    */
   deliverAt?: Date | null;
-  /** Optional number of days to retain the message payload. Defaults to 90. Note that this is mutually exclusive with `payloadRetentionHours`. */
+  /**
+   * Optional number of days to retain the message payload. Defaults to 90.
+   * Note that this is mutually exclusive with `payloadRetentionHours`.
+   */
   payloadRetentionPeriod?: number | null;
-  /** Optional number of hours to retain the message payload. Note that this is mutually exclusive with `payloadRetentionPeriod`. */
+  /**
+   * Optional number of hours to retain the message payload. Note that
+   * this is mutually exclusive with `payloadRetentionPeriod`.
+   */
   payloadRetentionHours?: number | null;
 }
 

package/src/models/operationalWebhookEndpointSecretIn.ts

@@ -11,7 +11,8 @@ export interface OperationalWebhookEndpointSecretIn {
   /**
    * 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/postgresConfigIn.ts

@@ -2,7 +2,8 @@
 
 export interface PostgresConfigIn {
   /**
-   * PostgreSQL connection URL, e.g. `postgres://user@host:5432/dbname?sslmode=require`.
+   * PostgreSQL connection URL, e.g.
+   * `postgres://user@host:5432/dbname?sslmode=require`.
    *
    * Do NOT embed a password here; use the `password` field instead.
    */
@@ -12,13 +13,16 @@ export interface PostgresConfigIn {
   /**
    * Table to insert into. May be schema-qualified (e.g. `public.events`).
    *
-   * Quote characters are not supported. Each dot-separated segment is automatically double-quoted when the query is built, so `public.events` becomes `"public"."events"`.
+   * Quote characters are not supported. Each dot-separated segment is automatically
+   * double-quoted when the query is built, so `public.events` becomes `"public"."events"`.
    */
   tableName: string;
   /**
    * PEM-encoded CA certificate used to verify the Postgres server's TLS certificate.
    *
-   * Supply this to trust a private or self-signed CA when connecting with `sslmode=verify-ca` or `sslmode=verify-full`. Without it, only the built-in public roots are trusted.
+   * Supply this to trust a private or self-signed CA when connecting with
+   * `sslmode=verify-ca` or `sslmode=verify-full`. Without it, only the built-in
+   * public roots are trusted.
    */
   sslRootCert?: string | null;
 }

package/src/models/rabbitMqConfigOut.ts

@@ -1,18 +1,21 @@
 // this file is @generated
 
 export interface RabbitMqConfigOut {
+  uri: string;
   routingKey: string;
 }
 
 export const RabbitMqConfigOutSerializer = {
   _fromJsonObject(object: any): RabbitMqConfigOut {
     return {
+      uri: object["uri"],
       routingKey: object["routingKey"],
     };
   },
 
   _toJsonObject(self: RabbitMqConfigOut): any {
     return {
+      uri: self.uri,
       routingKey: self.routingKey,
     };
   },

package/src/models/redshiftConfigIn.ts

@@ -3,7 +3,8 @@
 /**
  * Configuration parameters for defining a Redshift sink.
  *
- * For provisioned clusters, set `cluster_identifier` and `db_user`. For Redshift Serverless, set `workgroup_name`.
+ * For provisioned clusters, set `cluster_identifier` and `db_user`.
+ * For Redshift Serverless, set `workgroup_name`.
  */
 export interface RedshiftConfigIn {
   /**
@@ -29,7 +30,8 @@ export interface RedshiftConfigIn {
   /**
    * The region of the Redshift DB.
    *
-   * 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;
   /** Required for provisioned clusters. */

package/src/models/rotatePollerTokenIn.ts

@@ -6,7 +6,8 @@ export interface RotatePollerTokenIn {
   /**
    * Updates the previous token's expiration, in seconds.
    *
-   * If set to 0, the old token will immediately be revoked. Must be between 0 and 86,400 seconds (1 day).
+   * If set to 0, the old token will immediately be revoked.
+   * Must be between 0 and 86,400 seconds (1 day).
    *
    * Defaults to 300 seconds (5 minutes).
    */

package/src/models/s3ConfigIn.ts

@@ -17,7 +17,8 @@ export interface S3ConfigIn {
   /**
    * The region of the S3 bucket
    *
-   * 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;
   endpointUrl?: string | null;

package/src/models/snowflakeConfigIn.ts

@@ -3,14 +3,19 @@
 /** Configuration parameters for defining a Snowflake sink. */
 export interface SnowflakeConfigIn {
   /**
-   * PEM-encoded private key used for signing token-based requests to the Snowflake API.
+   * PEM-encoded private key used for signing token-based requests
+   * to the Snowflake API.
    *
    * Beginning/end delimiters are not required.
    *
-   * 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.
    */
   privateKey?: string | null;
-  /** Snowflake account identifier, which includes both the organization and account IDs separated by a hyphen. */
+  /**
+   * Snowflake account identifier, which includes both the organization and account
+   * IDs separated by a hyphen.
+   */
   accountIdentifier: string;
   /** The Snowflake user id. */
   userId: string;

package/src/models/snsConfigIn.ts

@@ -6,7 +6,8 @@ export interface SnsConfigIn {
   /**
    * The region of the SNS instance.
    *
-   * 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;
   /**

package/src/models/sqsConfigIn.ts

@@ -6,7 +6,8 @@ export interface SqsConfigIn {
   /**
    * The region of the SQS queue.
    *
-   * 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;
   /**

package/src/models/streamPortalAccessIn.ts

@@ -6,13 +6,15 @@ export interface StreamPortalAccessIn {
   /**
    * 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/streamSinkIn.ts

@@ -40,7 +40,8 @@ interface _StreamSinkInFields {
   /**
    * Whether the sink will receive events.
    *
-   * If the sink is `enabled`, any events posted to the stream will be dispatched to the Sink in the same order that events were posted to the stream.
+   * If the sink is `enabled`, any events posted to the stream will be
+   * dispatched to the Sink in the same order that events were posted to the stream.
    *
    * If the sink is `disabled`, events will not be dispatched to the sink until the sink is reenabled.
    */
@@ -55,7 +56,10 @@ interface _StreamSinkInFields {
    * Note that we will never send an empty batch of events to the Sink.
    */
   maxWaitSecs?: number;
-  /** A list of event types that filter which events are dispatched to the Sink. An empty list (or null) will not filter out any events. */
+  /**
+   * A list of event types that filter which events are dispatched to the Sink. An empty list (or null) will not filter out
+   * any events.
+   */
   eventTypes?: string[];
   channels?: string[];
   metadata?: { [key: string]: string };