svix 2.5.0 → 2.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. package/dist/index.d.mts +168 -54
  2. package/dist/index.d.mts.map +1 -1
  3. package/dist/index.mjs +76 -12
  4. package/dist/index.mjs.map +1 -1
  5. package/package.json +1 -1
  6. package/src/api/autoconfigSubscription.ts +23 -0
  7. package/src/api/endpoint.ts +39 -0
  8. package/src/api/eventType.ts +4 -1
  9. package/src/api/message.ts +6 -3
  10. package/src/api/messageAttempt.ts +6 -3
  11. package/src/models/appPortalAccessIn.ts +4 -2
  12. package/src/models/appUsageStatsOut.ts +7 -7
  13. package/src/models/applicationTokenExpireIn.ts +2 -1
  14. package/src/models/autoConfigOut.ts +1 -0
  15. package/src/models/autoConfigSubscriptionOut.ts +1 -0
  16. package/src/models/azureBlobStorageConfigIn.ts +2 -1
  17. package/src/models/clickhouseConfigIn.ts +4 -2
  18. package/src/models/connectorKind.ts +1 -0
  19. package/src/models/createAutoConfigSubscriptionIn.ts +25 -0
  20. package/src/models/createStreamEventsIn.ts +2 -1
  21. package/src/models/destinationIn.ts +14 -5
  22. package/src/models/endpointAttemptStats.ts +25 -0
  23. package/src/models/endpointMessageOut.ts +4 -1
  24. package/src/models/endpointSecretRotateIn.ts +2 -1
  25. package/src/models/eventBridgeConfigIn.ts +2 -1
  26. package/src/models/eventTypeImportOpenApiIn.ts +3 -1
  27. package/src/models/index.ts +2 -0
  28. package/src/models/ingestEndpointSecretIn.ts +2 -1
  29. package/src/models/ingestSourceConsumerPortalAccessIn.ts +2 -1
  30. package/src/models/messageIn.ts +12 -4
  31. package/src/models/operationalWebhookEndpointSecretIn.ts +2 -1
  32. package/src/models/postgresConfigIn.ts +7 -3
  33. package/src/models/rabbitMqConfigIn.ts +14 -0
  34. package/src/models/rabbitMqConfigOut.ts +6 -0
  35. package/src/models/rabbitMqConfigPatch.ts +3 -0
  36. package/src/models/redshiftConfigIn.ts +4 -2
  37. package/src/models/rotatePollerTokenIn.ts +2 -1
  38. package/src/models/s3ConfigIn.ts +2 -1
  39. package/src/models/snowflakeConfigIn.ts +8 -3
  40. package/src/models/snsConfigIn.ts +2 -1
  41. package/src/models/sqsConfigIn.ts +2 -1
  42. package/src/models/streamPortalAccessIn.ts +4 -2
  43. package/src/models/streamSinkIn.ts +6 -2
  44. package/src/models/streamTokenExpireIn.ts +2 -1
  45. package/src/request.ts +1 -1
package/dist/index.d.mts CHANGED
@@ -200,13 +200,15 @@ interface AppPortalAccessIn {
200
200
  /**
201
201
  * How long the token will be valid for, in seconds.
202
202
  *
203
- * Valid values are between 1 hour and 7 days. The default is 7 days.
203
+ * Valid values are between 1 hour and 7 days.
204
+ * The default is 7 days.
204
205
  */
205
206
  expiry?: number | null;
206
207
  /**
207
208
  * An optional session ID to attach to the token.
208
209
  *
209
- * When expiring tokens with "Expire All", you can include the session ID to only expire tokens that were created with that session ID.
210
+ * When expiring tokens with "Expire All", you can include the session ID
211
+ * to only expire tokens that were created with that session ID.
210
212
  */
211
213
  sessionId?: string | null;
212
214
  }
@@ -224,7 +226,8 @@ interface ApplicationTokenExpireIn {
224
226
  /**
225
227
  * An optional list of session ids.
226
228
  *
227
- * If any session ids are specified, only Application tokens created with that session id will be expired.
229
+ * If any session ids are specified, only Application tokens created with that
230
+ * session id will be expired.
228
231
  */
229
232
  sessionIds?: string[];
230
233
  }
@@ -236,7 +239,8 @@ interface RotatePollerTokenIn {
236
239
  /**
237
240
  * Updates the previous token's expiration, in seconds.
238
241
  *
239
- * If set to 0, the old token will immediately be revoked. Must be between 0 and 86,400 seconds (1 day).
242
+ * If set to 0, the old token will immediately be revoked.
243
+ * Must be between 0 and 86,400 seconds (1 day).
240
244
  *
241
245
  * Defaults to 300 seconds (5 minutes).
242
246
  */
@@ -250,13 +254,15 @@ interface StreamPortalAccessIn {
250
254
  /**
251
255
  * How long the token will be valid for, in seconds.
252
256
  *
253
- * Valid values are between 1 hour and 7 days. The default is 7 days.
257
+ * Valid values are between 1 hour and 7 days.
258
+ * The default is 7 days.
254
259
  */
255
260
  expiry?: number | null;
256
261
  /**
257
262
  * An optional session ID to attach to the token.
258
263
  *
259
- * When expiring tokens with "Expire All", you can include the session ID to only expire tokens that were created with that session ID.
264
+ * When expiring tokens with "Expire All", you can include the session ID
265
+ * to only expire tokens that were created with that session ID.
260
266
  */
261
267
  sessionId?: string | null;
262
268
  }
@@ -268,7 +274,8 @@ interface StreamTokenExpireIn {
268
274
  /**
269
275
  * An optional list of session ids.
270
276
  *
271
- * If any session ids are specified, only Stream tokens created with that session id will be expired.
277
+ * If any session ids are specified, only Stream tokens created with that
278
+ * session id will be expired.
272
279
  */
273
280
  sessionIds?: string[];
274
281
  }
@@ -327,11 +334,23 @@ declare class Authentication {
327
334
  //#region src/models/autoConfigOut.d.ts
328
335
  interface AutoConfigOut {
329
336
  createdAt: Date;
337
+ /** The AutoConfig token */
330
338
  token: string;
331
339
  /** The AutoConfigSubscription's ID. */
332
340
  id: string;
333
341
  }
334
342
  //#endregion
343
+ //#region src/models/createAutoConfigSubscriptionIn.d.ts
344
+ interface CreateAutoConfigSubscriptionIn {
345
+ /**
346
+ * The set of feature flags the created token will have access to.
347
+ *
348
+ * When omitted or empty, the token inherits the calling token's feature flags.
349
+ * When set, these flags are used instead. An application token may only grant a subset of its own flags.
350
+ */
351
+ featureFlags?: string[];
352
+ }
353
+ //#endregion
335
354
  //#region src/models/endpointSecretRotateIn.d.ts
336
355
  interface EndpointSecretRotateIn {
337
356
  /**
@@ -344,7 +363,8 @@ interface EndpointSecretRotateIn {
344
363
  /**
345
364
  * How long the old secret will be valid for, in seconds.
346
365
  *
347
- * Valid values are between 0 (immediate expiry) and 7 days. The default is 24 hours.
366
+ * Valid values are between 0 (immediate expiry) and 7 days.
367
+ * The default is 24 hours.
348
368
  */
349
369
  gracePeriodSeconds?: number | null;
350
370
  }
@@ -365,7 +385,9 @@ declare class AutoconfigSubscription {
365
385
  private readonly requestCtx;
366
386
  constructor(requestCtx: SvixRequestContext);
367
387
  /** Create an AutoConfig subscription. */
368
- create(appId: string, options?: AutoconfigSubscriptionCreateOptions): Promise<AutoConfigOut>;
388
+ create(appId: string, createAutoConfigSubscriptionIn?: CreateAutoConfigSubscriptionIn, options?: AutoconfigSubscriptionCreateOptions): Promise<AutoConfigOut>;
389
+ /** Delete an AutoConfig subscription. This also invalidates its auth token. */
390
+ delete(appId: string, autoconfigId: string): Promise<void>;
369
391
  /** Rotate the auth token and signing secret for an AutoConfig subscription. */
370
392
  rotate(appId: string, autoconfigId: string, rotateSubscriptionIn2?: RotateSubscriptionIn2, options?: AutoconfigSubscriptionRotateOptions): Promise<AutoConfigOut>;
371
393
  }
@@ -435,6 +457,7 @@ declare enum ConnectorKind {
435
457
  AgenticCommerceProtocol = "AgenticCommerceProtocol",
436
458
  CloseCrm = "CloseCRM",
437
459
  CustomerIo = "CustomerIO",
460
+ DatadogTracing = "DatadogTracing",
438
461
  Discord = "Discord",
439
462
  Hubspot = "Hubspot",
440
463
  Inngest = "Inngest",
@@ -563,7 +586,8 @@ interface AzureBlobStorageConfigIn {
563
586
  /**
564
587
  * Access key.
565
588
  *
566
- * Currently a required field, but marked as optional because we may add different authentication in the future.
589
+ * Currently a required field, but marked as optional because we may add
590
+ * different authentication in the future.
567
591
  */
568
592
  accessKey?: string | null;
569
593
  }
@@ -585,13 +609,15 @@ interface ClickhouseConfigIn {
585
609
  /**
586
610
  * Username to access Clickhouse.
587
611
  *
588
- * Currently a required field, but marked as optional because we may add different authentication in the future.
612
+ * Currently a required field, but marked as optional because we may add
613
+ * different authentication in the future.
589
614
  */
590
615
  username?: string | null;
591
616
  /**
592
617
  * Password to access Clickhouse.
593
618
  *
594
- * Currently a required field, but marked as optional because we may add different authentication in the future.
619
+ * Currently a required field, but marked as optional because we may add
620
+ * different authentication in the future.
595
621
  */
596
622
  password?: string | null;
597
623
  /** The Clickhouse database to connect to. */
@@ -635,7 +661,8 @@ interface EventBridgeConfigIn {
635
661
  /**
636
662
  * The region of the EventBridge bus.
637
663
  *
638
- * Currently a required field, but marked as optional because we may infer it from other fields in the future.
664
+ * Currently a required field, but marked as optional because we may infer
665
+ * it from other fields in the future.
639
666
  */
640
667
  region?: string | null;
641
668
  }
@@ -680,7 +707,8 @@ interface OtelTracingConfigIn {
680
707
  //#region src/models/postgresConfigIn.d.ts
681
708
  interface PostgresConfigIn {
682
709
  /**
683
- * PostgreSQL connection URL, e.g. `postgres://user@host:5432/dbname?sslmode=require`.
710
+ * PostgreSQL connection URL, e.g.
711
+ * `postgres://user@host:5432/dbname?sslmode=require`.
684
712
  *
685
713
  * Do NOT embed a password here; use the `password` field instead.
686
714
  */
@@ -690,13 +718,16 @@ interface PostgresConfigIn {
690
718
  /**
691
719
  * Table to insert into. May be schema-qualified (e.g. `public.events`).
692
720
  *
693
- * Quote characters are not supported. Each dot-separated segment is automatically double-quoted when the query is built, so `public.events` becomes `"public"."events"`.
721
+ * Quote characters are not supported. Each dot-separated segment is automatically
722
+ * double-quoted when the query is built, so `public.events` becomes `"public"."events"`.
694
723
  */
695
724
  tableName: string;
696
725
  /**
697
726
  * PEM-encoded CA certificate used to verify the Postgres server's TLS certificate.
698
727
  *
699
- * 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.
728
+ * Supply this to trust a private or self-signed CA when connecting with
729
+ * `sslmode=verify-ca` or `sslmode=verify-full`. Without it, only the built-in
730
+ * public roots are trusted.
700
731
  */
701
732
  sslRootCert?: string | null;
702
733
  }
@@ -704,15 +735,28 @@ interface PostgresConfigIn {
704
735
  //#region src/models/rabbitMqConfigIn.d.ts
705
736
  /** Configuration for a RabbitMq sink. */
706
737
  interface RabbitMqConfigIn {
738
+ /**
739
+ * URI to connect to
740
+ *
741
+ * Note that the VHost must be percent-escaped, so a default URI would look
742
+ * like `amqp://user:pass@host/%2F`
743
+ */
707
744
  uri: string;
745
+ /** Routing key for message dispatch */
708
746
  routingKey: string;
747
+ /**
748
+ * If true, then dispatches will fail if there is no attached queue; if false, they are
749
+ * silently dropped (this was previously the default)
750
+ */
751
+ mandatory?: boolean;
709
752
  }
710
753
  //#endregion
711
754
  //#region src/models/redshiftConfigIn.d.ts
712
755
  /**
713
756
  * Configuration parameters for defining a Redshift sink.
714
757
  *
715
- * For provisioned clusters, set `cluster_identifier` and `db_user`. For Redshift Serverless, set `workgroup_name`.
758
+ * For provisioned clusters, set `cluster_identifier` and `db_user`.
759
+ * For Redshift Serverless, set `workgroup_name`.
716
760
  */
717
761
  interface RedshiftConfigIn {
718
762
  /**
@@ -738,7 +782,8 @@ interface RedshiftConfigIn {
738
782
  /**
739
783
  * The region of the Redshift DB.
740
784
  *
741
- * Currently a required field, but marked as optional because we may infer it from other fields in the future.
785
+ * Currently a required field, but marked as optional because we may infer
786
+ * it from other fields in the future.
742
787
  */
743
788
  region?: string | null;
744
789
  /** Required for provisioned clusters. */
@@ -785,7 +830,8 @@ interface S3ConfigIn {
785
830
  /**
786
831
  * The region of the S3 bucket
787
832
  *
788
- * Currently a required field, but marked as optional because we may infer it from other fields in the future.
833
+ * Currently a required field, but marked as optional because we may infer
834
+ * it from other fields in the future.
789
835
  */
790
836
  region?: string | null;
791
837
  endpointUrl?: string | null;
@@ -803,14 +849,19 @@ interface S3ConfigIn {
803
849
  /** Configuration parameters for defining a Snowflake sink. */
804
850
  interface SnowflakeConfigIn {
805
851
  /**
806
- * PEM-encoded private key used for signing token-based requests to the Snowflake API.
852
+ * PEM-encoded private key used for signing token-based requests
853
+ * to the Snowflake API.
807
854
  *
808
855
  * Beginning/end delimiters are not required.
809
856
  *
810
- * Currently a required field, but marked as optional because we may add different authentication in the future.
857
+ * Currently a required field, but marked as optional because we may add
858
+ * different authentication in the future.
811
859
  */
812
860
  privateKey?: string | null;
813
- /** Snowflake account identifier, which includes both the organization and account IDs separated by a hyphen. */
861
+ /**
862
+ * Snowflake account identifier, which includes both the organization and account
863
+ * IDs separated by a hyphen.
864
+ */
814
865
  accountIdentifier: string;
815
866
  /** The Snowflake user id. */
816
867
  userId: string;
@@ -841,7 +892,8 @@ interface SnsConfigIn {
841
892
  /**
842
893
  * The region of the SNS instance.
843
894
  *
844
- * Currently a required field, but marked as optional because we may infer it from other fields in the future.
895
+ * Currently a required field, but marked as optional because we may infer
896
+ * it from other fields in the future.
845
897
  */
846
898
  region?: string | null;
847
899
  /**
@@ -874,7 +926,8 @@ interface SqsConfigIn {
874
926
  /**
875
927
  * The region of the SQS queue.
876
928
  *
877
- * Currently a required field, but marked as optional because we may infer it from other fields in the future.
929
+ * Currently a required field, but marked as optional because we may infer
930
+ * it from other fields in the future.
878
931
  */
879
932
  region?: string | null;
880
933
  /**
@@ -907,9 +960,11 @@ interface _DestinationInFields {
907
960
  /**
908
961
  * Whether the destination will receive events.
909
962
  *
910
- * If the destination is `enabled`, events sent to the application will be dispatched to the destination in order.
963
+ * If the destination is `enabled`, events sent to the application will be
964
+ * dispatched to the destination in order.
911
965
  *
912
- * If the destination is `disabled`, events will not be dispatched until the destination is reenabled.
966
+ * If the destination is `disabled`, events will not be dispatched until the
967
+ * destination is reenabled.
913
968
  */
914
969
  status?: DestinationStatusIn;
915
970
  /** How many events will be batched in a request to the destination. */
@@ -917,14 +972,21 @@ interface _DestinationInFields {
917
972
  /**
918
973
  * How long to wait before a batch of events is sent, if the `batchSize` is not reached.
919
974
  *
920
- * For example, with a `batchSize` of 100 and `maxWaitSecs` of 10, a request is sent after 10 seconds or 100 events, whichever comes first.
975
+ * For example, with a `batchSize` of 100 and `maxWaitSecs` of 10, a request is sent after
976
+ * 10 seconds or 100 events, whichever comes first.
921
977
  *
922
978
  * Note that an empty batch is never sent to the destination.
923
979
  */
924
980
  maxWaitSecs?: number;
925
- /** 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. */
981
+ /**
982
+ * A list of event types that filter which events are dispatched to the destination.
983
+ * An empty list (or null) will not filter out any events.
984
+ */
926
985
  eventTypes?: string[];
927
- /** A list of channels that filter which events are dispatched to the destination. An empty list (or null) will not filter out any events. */
986
+ /**
987
+ * A list of channels that filter which events are dispatched to the destination.
988
+ * An empty list (or null) will not filter out any events.
989
+ */
928
990
  channels?: string[];
929
991
  metadata?: {
930
992
  [key: string]: string;
@@ -1076,7 +1138,9 @@ interface PostgresConfigOut {
1076
1138
  //#endregion
1077
1139
  //#region src/models/rabbitMqConfigOut.d.ts
1078
1140
  interface RabbitMqConfigOut {
1141
+ uri: string;
1079
1142
  routingKey: string;
1143
+ mandatory: boolean;
1080
1144
  }
1081
1145
  //#endregion
1082
1146
  //#region src/models/redshiftConfigOut.d.ts
@@ -1319,6 +1383,7 @@ interface PostgresConfigPatch {
1319
1383
  interface RabbitMqConfigPatch {
1320
1384
  routingKey?: string;
1321
1385
  uri?: string;
1386
+ mandatory?: boolean;
1322
1387
  }
1323
1388
  //#endregion
1324
1389
  //#region src/models/redshiftConfigPatch.d.ts
@@ -1602,6 +1667,13 @@ interface BulkReplayIn {
1602
1667
  statusCodeClass?: StatusCodeClass | null;
1603
1668
  }
1604
1669
  //#endregion
1670
+ //#region src/models/endpointAttemptStats.d.ts
1671
+ interface EndpointAttemptStats {
1672
+ success: number;
1673
+ fail: number;
1674
+ canceled: number;
1675
+ }
1676
+ //#endregion
1605
1677
  //#region src/models/endpointHeadersIn.d.ts
1606
1678
  interface EndpointHeadersIn {
1607
1679
  headers: {
@@ -1863,6 +1935,12 @@ interface EndpointGetStatsOptions {
1863
1935
  /** Filter the range to data ending by this date. */
1864
1936
  until?: Date | null;
1865
1937
  }
1938
+ interface EndpointGetAttemptStatsOptions {
1939
+ /** Filter the range to data starting from this date. */
1940
+ since?: Date | null;
1941
+ /** Filter the range to data ending by this date. */
1942
+ until?: Date | null;
1943
+ }
1866
1944
  interface EndpointRecoverOptions {
1867
1945
  idempotencyKey?: string;
1868
1946
  }
@@ -1948,6 +2026,12 @@ declare class Endpoint {
1948
2026
  bulkReplay(appId: string, endpointId: string, bulkReplayIn: BulkReplayIn, options?: EndpointBulkReplayOptions): Promise<ReplayOut>;
1949
2027
  /** Get basic statistics for the endpoint. */
1950
2028
  getStats(appId: string, endpointId: string, options?: EndpointGetStatsOptions): Promise<EndpointStats>;
2029
+ /**
2030
+ * Get basic statistics about attempted deliveries for the endpoint.
2031
+ *
2032
+ * Time windows are always rounded to hour granularity
2033
+ */
2034
+ getAttemptStats(appId: string, endpointId: string, options?: EndpointGetAttemptStatsOptions): Promise<EndpointAttemptStats>;
1951
2035
  /**
1952
2036
  * Resend all failed messages since a given time.
1953
2037
  *
@@ -2055,7 +2139,9 @@ declare class Environment {
2055
2139
  /**
2056
2140
  * Import a list of event types from webhooks defined in an OpenAPI spec.
2057
2141
  *
2058
- * 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**.
2142
+ * The OpenAPI spec can be specified as either `spec` given the spec as a JSON object, or as `specRaw`
2143
+ * (a `string`) which will be parsed as YAML or JSON by the server.
2144
+ * Sending neither or both is invalid, resulting in a `400` **Bad Request**.
2059
2145
  */
2060
2146
  interface EventTypeImportOpenApiIn {
2061
2147
  /** If `true`, return the event types that would be modified without actually modifying them. */
@@ -2142,7 +2228,10 @@ interface EventTypeImportOpenapiOptions {
2142
2228
  idempotencyKey?: string;
2143
2229
  }
2144
2230
  interface EventTypeDeleteOptions {
2145
- /** By default event types are archived when "deleted". Passing this to `true` deletes them entirely. */
2231
+ /**
2232
+ * By default event types are archived when "deleted". Passing this to `true` deletes them
2233
+ * entirely.
2234
+ */
2146
2235
  expunge?: boolean;
2147
2236
  }
2148
2237
  declare class EventType {
@@ -2196,7 +2285,8 @@ interface IngestSourceConsumerPortalAccessIn {
2196
2285
  /**
2197
2286
  * How long the token will be valid for, in seconds.
2198
2287
  *
2199
- * Valid values are between 1 hour and 7 days. The default is 7 days.
2288
+ * Valid values are between 1 hour and 7 days.
2289
+ * The default is 7 days.
2200
2290
  */
2201
2291
  expiry?: number | null;
2202
2292
  /** Whether the app portal should be in read-only mode. */
@@ -2291,7 +2381,8 @@ interface IngestEndpointSecretIn {
2291
2381
  /**
2292
2382
  * How long the old secret will be valid for, in seconds.
2293
2383
  *
2294
- * Valid values are between 0 (immediate expiry) and 7 days. The default is 24 hours.
2384
+ * Valid values are between 0 (immediate expiry) and 7 days.
2385
+ * The default is 24 hours.
2295
2386
  */
2296
2387
  gracePeriodSeconds?: number | null;
2297
2388
  }
@@ -3292,7 +3383,8 @@ interface MessageIn {
3292
3383
  /**
3293
3384
  * Optionally creates a new application alongside the message.
3294
3385
  *
3295
- * If the application id or uid that is used in the path already exists, this argument is ignored.
3386
+ * If the application id or uid that is used in the path already exists,
3387
+ * this argument is ignored.
3296
3388
  */
3297
3389
  application?: ApplicationIn | null;
3298
3390
  /** List of free-form tags that can be filtered by when listing messages */
@@ -3302,12 +3394,19 @@ interface MessageIn {
3302
3394
  /**
3303
3395
  * The date and time at which the message will be delivered.
3304
3396
  *
3305
- * Note that this time is best-effort-only. Must be at least one minute and no more than 24 hours in the future.
3397
+ * Note that this time is best-effort-only. Must be at least one minute
3398
+ * and no more than 24 hours in the future.
3306
3399
  */
3307
3400
  deliverAt?: Date | null;
3308
- /** Optional number of days to retain the message payload. Defaults to 90. Note that this is mutually exclusive with `payloadRetentionHours`. */
3401
+ /**
3402
+ * Optional number of days to retain the message payload. Defaults to 90.
3403
+ * Note that this is mutually exclusive with `payloadRetentionHours`.
3404
+ */
3309
3405
  payloadRetentionPeriod?: number | null;
3310
- /** Optional number of hours to retain the message payload. Note that this is mutually exclusive with `payloadRetentionPeriod`. */
3406
+ /**
3407
+ * Optional number of hours to retain the message payload. Note that
3408
+ * this is mutually exclusive with `payloadRetentionPeriod`.
3409
+ */
3311
3410
  payloadRetentionHours?: number | null;
3312
3411
  }
3313
3412
  //#endregion
@@ -3326,7 +3425,8 @@ interface MessageListOptions {
3326
3425
  /**
3327
3426
  * When `true` message payloads are included in the response.
3328
3427
  *
3329
- * Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request without specifying this parameter.
3428
+ * Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request
3429
+ * without specifying this parameter.
3330
3430
  */
3331
3431
  withContent?: boolean;
3332
3432
  /** Filter messages matching the provided tag. */
@@ -3338,7 +3438,8 @@ interface MessageCreateOptions {
3338
3438
  /**
3339
3439
  * When `true`, message payloads are included in the response.
3340
3440
  *
3341
- * Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request without specifying this parameter.
3441
+ * Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request
3442
+ * without specifying this parameter.
3342
3443
  */
3343
3444
  withContent?: boolean;
3344
3445
  idempotencyKey?: string;
@@ -3350,7 +3451,8 @@ interface MessageGetOptions {
3350
3451
  /**
3351
3452
  * When `true` message payloads are included in the response.
3352
3453
  *
3353
- * Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request without specifying this parameter.
3454
+ * Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request
3455
+ * without specifying this parameter.
3354
3456
  */
3355
3457
  withContent?: boolean;
3356
3458
  }
@@ -3460,7 +3562,10 @@ declare enum MessageStatusText {
3460
3562
  }
3461
3563
  //#endregion
3462
3564
  //#region src/models/endpointMessageOut.d.ts
3463
- /** A model containing information on a given message plus additional fields on the last attempt for that message. */
3565
+ /**
3566
+ * A model containing information on a given message plus additional fields on the last attempt for
3567
+ * that message.
3568
+ */
3464
3569
  interface EndpointMessageOut {
3465
3570
  status: MessageStatus;
3466
3571
  statusText: MessageStatusText;
@@ -3581,7 +3686,8 @@ interface MessageAttemptListByEndpointOptions {
3581
3686
  /**
3582
3687
  * When `true` attempt content is included in the response.
3583
3688
  *
3584
- * Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request without specifying this parameter.
3689
+ * Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request
3690
+ * without specifying this parameter.
3585
3691
  */
3586
3692
  withContent?: boolean;
3587
3693
  /**
@@ -3621,7 +3727,8 @@ interface MessageAttemptListByMsgOptions {
3621
3727
  /**
3622
3728
  * When `true` attempt content is included in the response.
3623
3729
  *
3624
- * Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request without specifying this parameter.
3730
+ * Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request
3731
+ * without specifying this parameter.
3625
3732
  */
3626
3733
  withContent?: boolean;
3627
3734
  /**
@@ -3651,7 +3758,8 @@ interface MessageAttemptListAttemptedMessagesOptions {
3651
3758
  /**
3652
3759
  * When `true` message payloads are included in the response.
3653
3760
  *
3654
- * Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request without specifying this parameter.
3761
+ * Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request
3762
+ * without specifying this parameter.
3655
3763
  */
3656
3764
  withContent?: boolean;
3657
3765
  /**
@@ -3820,7 +3928,8 @@ interface OperationalWebhookEndpointSecretIn {
3820
3928
  /**
3821
3929
  * How long the old secret will be valid for, in seconds.
3822
3930
  *
3823
- * Valid values are between 0 (immediate expiry) and 7 days. The default is 24 hours.
3931
+ * Valid values are between 0 (immediate expiry) and 7 days.
3932
+ * The default is 24 hours.
3824
3933
  */
3825
3934
  gracePeriodSeconds?: number | null;
3826
3935
  }
@@ -3932,17 +4041,17 @@ interface AppUsageStatsIn {
3932
4041
  //#endregion
3933
4042
  //#region src/models/appUsageStatsOut.d.ts
3934
4043
  interface AppUsageStatsOut {
4044
+ /** The QueueBackgroundTask's ID. */
4045
+ id: string;
4046
+ status: BackgroundTaskStatus;
4047
+ task: BackgroundTaskType;
4048
+ updatedAt: Date;
3935
4049
  /**
3936
4050
  * Any app IDs or UIDs received in the request that weren't found.
3937
4051
  *
3938
4052
  * Stats will be produced for all the others.
3939
4053
  */
3940
4054
  unresolvedAppIds: string[];
3941
- /** The QueueBackgroundTask's ID. */
3942
- id: string;
3943
- status: BackgroundTaskStatus;
3944
- task: BackgroundTaskType;
3945
- updatedAt: Date;
3946
4055
  }
3947
4056
  //#endregion
3948
4057
  //#region src/api/statistics.d.ts
@@ -4108,7 +4217,8 @@ interface CreateStreamEventsIn {
4108
4217
  /**
4109
4218
  * Optionally creates a new Stream alongside the events.
4110
4219
  *
4111
- * If the stream id or uid that is used in the path already exists, this argument is ignored.
4220
+ * If the stream id or uid that is used in the path already exists,
4221
+ * this argument is ignored.
4112
4222
  */
4113
4223
  stream?: StreamIn | null;
4114
4224
  }
@@ -4296,7 +4406,8 @@ interface _StreamSinkInFields {
4296
4406
  /**
4297
4407
  * Whether the sink will receive events.
4298
4408
  *
4299
- * 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.
4409
+ * If the sink is `enabled`, any events posted to the stream will be
4410
+ * dispatched to the Sink in the same order that events were posted to the stream.
4300
4411
  *
4301
4412
  * If the sink is `disabled`, events will not be dispatched to the sink until the sink is reenabled.
4302
4413
  */
@@ -4311,7 +4422,10 @@ interface _StreamSinkInFields {
4311
4422
  * Note that we will never send an empty batch of events to the Sink.
4312
4423
  */
4313
4424
  maxWaitSecs?: number;
4314
- /** 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. */
4425
+ /**
4426
+ * A list of event types that filter which events are dispatched to the Sink. An empty list (or null) will not filter out
4427
+ * any events.
4428
+ */
4315
4429
  eventTypes?: string[];
4316
4430
  channels?: string[];
4317
4431
  metadata?: {
@@ -4853,5 +4967,5 @@ declare class Svix {
4853
4967
  get streaming(): Streaming;
4854
4968
  }
4855
4969
  //#endregion
4856
- export { type AdobeSignConfig, type AdobeSignConfigOut, type AggregateEventTypesOut, type AirwallexConfig, type AirwallexConfigOut, ApiException, type ApiTokenOut, type AppPortalAccessIn, type AppPortalAccessOut, AppPortalCapability, type AppUsageStatsIn, type AppUsageStatsOut, type ApplicationIn, type ApplicationListOptions, type ApplicationOut, type ApplicationPatch, type ApplicationTokenExpireIn, AutoConfig, AutoConfigConsumer, AutoConfigError, type AutoConfigOut, type AzureBlobStorageConfigIn, type AzureBlobStorageConfigOut, type AzureBlobStorageConfigPatch, type BackgroundTaskListOptions, type BackgroundTaskOut, BackgroundTaskStatus, BackgroundTaskType, type BigQueryConfigIn, type BigQueryConfigOut, type BigQueryConfigPatch, type BulkExpungeContentsIn, type BulkExpungeContentsOut, BulkExpungeStatus, type BulkReplayIn, type CheckbookConfig, type CheckbookConfigOut, type ClickhouseConfigIn, type ClickhouseConfigOut, type ClickhouseConfigPatch, type ConnectorIn, ConnectorKind, type ConnectorOut, type ConnectorPatch, ConnectorProduct, type ConnectorUpsertIn, type CreateStreamEventsIn, type CreateStreamEventsOut, type CronConfig, type DestinationIn, type DestinationOut, type DestinationPatch, DestinationStatus, DestinationStatusIn, type DestinationTransformIn, type DestinationTransformationOut, type DocusignConfig, type DocusignConfigOut, type EasypostConfig, type EasypostConfigOut, type EmptyResponse, type EndpointGetStatsOptions, type EndpointHeadersIn, type EndpointHeadersOut, type EndpointHeadersPatchIn, type EndpointIn, type EndpointListOptions, type EndpointMessageOut, type EndpointOut, type EndpointPatch, type EndpointSecretOut, type EndpointSecretRotateIn, type EndpointStats, type EndpointTransformationIn, type EndpointTransformationOut, type EndpointTransformationPatch, type EndpointUpsertIn, type EnvironmentIn, type EnvironmentOut, type EventBridgeConfigIn, type EventBridgeConfigOut, type EventBridgeConfigPatch, type EventExampleIn, type EventIn, type EventOut, type EventStreamOut, type EventTypeFromOpenApi, type EventTypeImportOpenApiIn, type EventTypeImportOpenApiOut, type EventTypeImportOpenApiOutData, type EventTypeIn, type EventTypeListOptions, type EventTypeOut, type EventTypePatch, type EventTypeUpsertIn, type ExpungeAllContentsOut, type FifoEndpointConfigIn, type GithubConfig, type GithubConfigOut, type GoogleCloudPubSubConfigIn, type GoogleCloudPubSubConfigOut, type GoogleCloudPubSubConfigPatch, type GoogleCloudStorageConfigIn, type GoogleCloudStorageConfigOut, type GoogleCloudStorageConfigPatch, HTTPValidationError, HttpErrorOut, type HttpSinkHeadersPatchIn, type HubspotConfig, type HubspotConfigOut, type IngestEndpointHeadersIn, type IngestEndpointHeadersOut, type IngestEndpointIn, type IngestEndpointOut, type IngestEndpointSecretIn, type IngestEndpointSecretOut, type IngestEndpointTransformationOut, type IngestEndpointTransformationPatch, type IngestEndpointUpsertIn, type IngestSourceConsumerPortalAccessIn, type IngestSourceIn, type IngestSourceOut, type IntegrationIn, type IntegrationKeyOut, type IntegrationListOptions, type IntegrationOut, type IntegrationUpdate, type ListResponseApplicationOut, type ListResponseBackgroundTaskOut, type ListResponseConnectorOut, type ListResponseDestinationOut, type ListResponseEndpointMessageOut, type ListResponseEndpointOut, type ListResponseEventTypeOut, type ListResponseIngestEndpointOut, type ListResponseIngestSourceOut, type ListResponseIntegrationOut, type ListResponseMessageAttemptOut, type ListResponseMessageEndpointOut, type ListResponseMessageOut, type ListResponseOperationalWebhookEndpointOut, type ListResponseStreamEventTypeOut, type ListResponseStreamOut, type ListResponseStreamSinkOut, type MergeConfig, type MergeConfigOut, type MessageAttemptListByEndpointOptions, type MessageAttemptOut, MessageAttemptTriggerType, type MessageEndpointOut, type MessageIn, type MessageListOptions, type MessageOut, type MessagePrecheckIn, type MessagePrecheckOut, MessageStatus, MessageStatusText, type MetaConfig, type MetaConfigOut, type NangoConfig, type NangoConfigOut, type OpenClawConfig, type OpenClawConfigOut, type OperationalWebhookEndpointHeadersIn, type OperationalWebhookEndpointHeadersOut, type OperationalWebhookEndpointIn, type OperationalWebhookEndpointOut, type OperationalWebhookEndpointSecretIn, type OperationalWebhookEndpointSecretOut, type OperationalWebhookEndpointUpsertIn, Ordering, type OrumIoConfig, type OrumIoConfigOut, type OtelTracingConfigIn, type OtelTracingConfigOut, type OtelTracingConfigPatch, type PandaDocConfig, type PandaDocConfigOut, type PollingEndpointConsumerSeekIn, type PollingEndpointConsumerSeekOut, type PollingEndpointMessageOut, type PollingEndpointOut, type PortIoConfig, type PortIoConfigOut, type PostOptions, type PostgresConfigIn, type PostgresConfigOut, type PostgresConfigPatch, type RabbitMqConfigIn, type RabbitMqConfigOut, type RabbitMqConfigPatch, type RecoverIn, type RecoverOut, type RedshiftConfigIn, type RedshiftConfigOut, type RedshiftConfigPatch, type ReplayIn, type ReplayOut, type RotatePollerTokenIn, type RotateSubscriptionIn2, type RotateTokenOut, type RutterConfig, type RutterConfigOut, type S3ConfigIn, type S3ConfigOut, type S3ConfigPatch, type SegmentConfig, type SegmentConfigOut, type ShopifyConfig, type ShopifyConfigOut, type SinkHttpConfigIn, type SinkHttpConfigOut, type SinkHttpConfigPatch, type SinkSecretOut, SinkStatus, SinkStatusIn, type SinkTransformIn, type SinkTransformationOut, type SlackConfig, type SlackConfigOut, type SnowflakeConfigIn, type SnowflakeConfigOut, type SnowflakeConfigPatch, type SnsConfigIn, type SnsConfigOut, type SnsConfigPatch, type SqsConfigIn, type SqsConfigOut, type SqsConfigPatch, StatusCodeClass, type StreamEventTypeIn, type StreamEventTypeOut, type StreamEventTypePatch, type StreamIn, type StreamOut, type StreamPatch, type StreamPortalAccessIn, type StreamSinkIn, type StreamSinkOut, type StreamSinkPatch, type StreamTokenExpireIn, type StripeConfig, type StripeConfigOut, Svix, type SvixConfig, type SvixConfigOut, SvixOptions, type TailscaleConfig, type TailscaleConfigOut, type TelnyxConfig, type TelnyxConfigOut, ValidationError, type VapiConfig, type VapiConfigOut, type VeriffConfig, type VeriffConfigOut, type VgsConfig, type VgsConfigOut, Webhook, WebhookOptions, WebhookRequiredHeaders, WebhookUnbrandedRequiredHeaders, WebhookVerificationError, type ZoomConfig, type ZoomConfigOut, messageInRaw };
4970
+ export { type AdobeSignConfig, type AdobeSignConfigOut, type AggregateEventTypesOut, type AirwallexConfig, type AirwallexConfigOut, ApiException, type ApiTokenOut, type AppPortalAccessIn, type AppPortalAccessOut, AppPortalCapability, type AppUsageStatsIn, type AppUsageStatsOut, type ApplicationIn, type ApplicationListOptions, type ApplicationOut, type ApplicationPatch, type ApplicationTokenExpireIn, AutoConfig, AutoConfigConsumer, AutoConfigError, type AutoConfigOut, type AzureBlobStorageConfigIn, type AzureBlobStorageConfigOut, type AzureBlobStorageConfigPatch, type BackgroundTaskListOptions, type BackgroundTaskOut, BackgroundTaskStatus, BackgroundTaskType, type BigQueryConfigIn, type BigQueryConfigOut, type BigQueryConfigPatch, type BulkExpungeContentsIn, type BulkExpungeContentsOut, BulkExpungeStatus, type BulkReplayIn, type CheckbookConfig, type CheckbookConfigOut, type ClickhouseConfigIn, type ClickhouseConfigOut, type ClickhouseConfigPatch, type ConnectorIn, ConnectorKind, type ConnectorOut, type ConnectorPatch, ConnectorProduct, type ConnectorUpsertIn, type CreateAutoConfigSubscriptionIn, type CreateStreamEventsIn, type CreateStreamEventsOut, type CronConfig, type DestinationIn, type DestinationOut, type DestinationPatch, DestinationStatus, DestinationStatusIn, type DestinationTransformIn, type DestinationTransformationOut, type DocusignConfig, type DocusignConfigOut, type EasypostConfig, type EasypostConfigOut, type EmptyResponse, type EndpointAttemptStats, type EndpointGetStatsOptions, type EndpointHeadersIn, type EndpointHeadersOut, type EndpointHeadersPatchIn, type EndpointIn, type EndpointListOptions, type EndpointMessageOut, type EndpointOut, type EndpointPatch, type EndpointSecretOut, type EndpointSecretRotateIn, type EndpointStats, type EndpointTransformationIn, type EndpointTransformationOut, type EndpointTransformationPatch, type EndpointUpsertIn, type EnvironmentIn, type EnvironmentOut, type EventBridgeConfigIn, type EventBridgeConfigOut, type EventBridgeConfigPatch, type EventExampleIn, type EventIn, type EventOut, type EventStreamOut, type EventTypeFromOpenApi, type EventTypeImportOpenApiIn, type EventTypeImportOpenApiOut, type EventTypeImportOpenApiOutData, type EventTypeIn, type EventTypeListOptions, type EventTypeOut, type EventTypePatch, type EventTypeUpsertIn, type ExpungeAllContentsOut, type FifoEndpointConfigIn, type GithubConfig, type GithubConfigOut, type GoogleCloudPubSubConfigIn, type GoogleCloudPubSubConfigOut, type GoogleCloudPubSubConfigPatch, type GoogleCloudStorageConfigIn, type GoogleCloudStorageConfigOut, type GoogleCloudStorageConfigPatch, HTTPValidationError, HttpErrorOut, type HttpSinkHeadersPatchIn, type HubspotConfig, type HubspotConfigOut, type IngestEndpointHeadersIn, type IngestEndpointHeadersOut, type IngestEndpointIn, type IngestEndpointOut, type IngestEndpointSecretIn, type IngestEndpointSecretOut, type IngestEndpointTransformationOut, type IngestEndpointTransformationPatch, type IngestEndpointUpsertIn, type IngestSourceConsumerPortalAccessIn, type IngestSourceIn, type IngestSourceOut, type IntegrationIn, type IntegrationKeyOut, type IntegrationListOptions, type IntegrationOut, type IntegrationUpdate, type ListResponseApplicationOut, type ListResponseBackgroundTaskOut, type ListResponseConnectorOut, type ListResponseDestinationOut, type ListResponseEndpointMessageOut, type ListResponseEndpointOut, type ListResponseEventTypeOut, type ListResponseIngestEndpointOut, type ListResponseIngestSourceOut, type ListResponseIntegrationOut, type ListResponseMessageAttemptOut, type ListResponseMessageEndpointOut, type ListResponseMessageOut, type ListResponseOperationalWebhookEndpointOut, type ListResponseStreamEventTypeOut, type ListResponseStreamOut, type ListResponseStreamSinkOut, type MergeConfig, type MergeConfigOut, type MessageAttemptListByEndpointOptions, type MessageAttemptOut, MessageAttemptTriggerType, type MessageEndpointOut, type MessageIn, type MessageListOptions, type MessageOut, type MessagePrecheckIn, type MessagePrecheckOut, MessageStatus, MessageStatusText, type MetaConfig, type MetaConfigOut, type NangoConfig, type NangoConfigOut, type OpenClawConfig, type OpenClawConfigOut, type OperationalWebhookEndpointHeadersIn, type OperationalWebhookEndpointHeadersOut, type OperationalWebhookEndpointIn, type OperationalWebhookEndpointOut, type OperationalWebhookEndpointSecretIn, type OperationalWebhookEndpointSecretOut, type OperationalWebhookEndpointUpsertIn, Ordering, type OrumIoConfig, type OrumIoConfigOut, type OtelTracingConfigIn, type OtelTracingConfigOut, type OtelTracingConfigPatch, type PandaDocConfig, type PandaDocConfigOut, type PollingEndpointConsumerSeekIn, type PollingEndpointConsumerSeekOut, type PollingEndpointMessageOut, type PollingEndpointOut, type PortIoConfig, type PortIoConfigOut, type PostOptions, type PostgresConfigIn, type PostgresConfigOut, type PostgresConfigPatch, type RabbitMqConfigIn, type RabbitMqConfigOut, type RabbitMqConfigPatch, type RecoverIn, type RecoverOut, type RedshiftConfigIn, type RedshiftConfigOut, type RedshiftConfigPatch, type ReplayIn, type ReplayOut, type RotatePollerTokenIn, type RotateSubscriptionIn2, type RotateTokenOut, type RutterConfig, type RutterConfigOut, type S3ConfigIn, type S3ConfigOut, type S3ConfigPatch, type SegmentConfig, type SegmentConfigOut, type ShopifyConfig, type ShopifyConfigOut, type SinkHttpConfigIn, type SinkHttpConfigOut, type SinkHttpConfigPatch, type SinkSecretOut, SinkStatus, SinkStatusIn, type SinkTransformIn, type SinkTransformationOut, type SlackConfig, type SlackConfigOut, type SnowflakeConfigIn, type SnowflakeConfigOut, type SnowflakeConfigPatch, type SnsConfigIn, type SnsConfigOut, type SnsConfigPatch, type SqsConfigIn, type SqsConfigOut, type SqsConfigPatch, StatusCodeClass, type StreamEventTypeIn, type StreamEventTypeOut, type StreamEventTypePatch, type StreamIn, type StreamOut, type StreamPatch, type StreamPortalAccessIn, type StreamSinkIn, type StreamSinkOut, type StreamSinkPatch, type StreamTokenExpireIn, type StripeConfig, type StripeConfigOut, Svix, type SvixConfig, type SvixConfigOut, SvixOptions, type TailscaleConfig, type TailscaleConfigOut, type TelnyxConfig, type TelnyxConfigOut, ValidationError, type VapiConfig, type VapiConfigOut, type VeriffConfig, type VeriffConfigOut, type VgsConfig, type VgsConfigOut, Webhook, WebhookOptions, WebhookRequiredHeaders, WebhookUnbrandedRequiredHeaders, WebhookVerificationError, type ZoomConfig, type ZoomConfigOut, messageInRaw };
4857
4971
  //# sourceMappingURL=index.d.mts.map