svix 2.5.0 → 2.6.0
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.
- package/dist/index.d.mts +139 -53
- package/dist/index.d.mts.map +1 -1
- package/dist/index.mjs +46 -7
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
- package/src/api/endpoint.ts +39 -0
- package/src/api/eventType.ts +4 -1
- package/src/api/message.ts +6 -3
- package/src/api/messageAttempt.ts +6 -3
- package/src/models/appPortalAccessIn.ts +4 -2
- package/src/models/appUsageStatsOut.ts +7 -7
- package/src/models/applicationTokenExpireIn.ts +2 -1
- package/src/models/autoConfigOut.ts +1 -0
- package/src/models/autoConfigSubscriptionOut.ts +1 -0
- package/src/models/azureBlobStorageConfigIn.ts +2 -1
- package/src/models/clickhouseConfigIn.ts +4 -2
- package/src/models/createStreamEventsIn.ts +2 -1
- package/src/models/destinationIn.ts +14 -5
- package/src/models/endpointAttemptStats.ts +25 -0
- package/src/models/endpointMessageOut.ts +4 -1
- package/src/models/endpointSecretRotateIn.ts +2 -1
- package/src/models/eventBridgeConfigIn.ts +2 -1
- package/src/models/eventTypeImportOpenApiIn.ts +3 -1
- package/src/models/index.ts +1 -0
- package/src/models/ingestEndpointSecretIn.ts +2 -1
- package/src/models/ingestSourceConsumerPortalAccessIn.ts +2 -1
- package/src/models/messageIn.ts +12 -4
- package/src/models/operationalWebhookEndpointSecretIn.ts +2 -1
- package/src/models/postgresConfigIn.ts +7 -3
- package/src/models/rabbitMqConfigOut.ts +3 -0
- package/src/models/redshiftConfigIn.ts +4 -2
- package/src/models/rotatePollerTokenIn.ts +2 -1
- package/src/models/s3ConfigIn.ts +2 -1
- package/src/models/snowflakeConfigIn.ts +8 -3
- package/src/models/snsConfigIn.ts +2 -1
- package/src/models/sqsConfigIn.ts +2 -1
- package/src/models/streamPortalAccessIn.ts +4 -2
- package/src/models/streamSinkIn.ts +6 -2
- package/src/models/streamTokenExpireIn.ts +2 -1
- 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.
|
|
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
|
|
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
|
|
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.
|
|
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.
|
|
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
|
|
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
|
|
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,6 +334,7 @@ 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;
|
|
@@ -344,7 +352,8 @@ interface EndpointSecretRotateIn {
|
|
|
344
352
|
/**
|
|
345
353
|
* How long the old secret will be valid for, in seconds.
|
|
346
354
|
*
|
|
347
|
-
* Valid values are between 0 (immediate expiry) and 7 days.
|
|
355
|
+
* Valid values are between 0 (immediate expiry) and 7 days.
|
|
356
|
+
* The default is 24 hours.
|
|
348
357
|
*/
|
|
349
358
|
gracePeriodSeconds?: number | null;
|
|
350
359
|
}
|
|
@@ -563,7 +572,8 @@ interface AzureBlobStorageConfigIn {
|
|
|
563
572
|
/**
|
|
564
573
|
* Access key.
|
|
565
574
|
*
|
|
566
|
-
* Currently a required field, but marked as optional because we may add
|
|
575
|
+
* Currently a required field, but marked as optional because we may add
|
|
576
|
+
* different authentication in the future.
|
|
567
577
|
*/
|
|
568
578
|
accessKey?: string | null;
|
|
569
579
|
}
|
|
@@ -585,13 +595,15 @@ interface ClickhouseConfigIn {
|
|
|
585
595
|
/**
|
|
586
596
|
* Username to access Clickhouse.
|
|
587
597
|
*
|
|
588
|
-
* Currently a required field, but marked as optional because we may add
|
|
598
|
+
* Currently a required field, but marked as optional because we may add
|
|
599
|
+
* different authentication in the future.
|
|
589
600
|
*/
|
|
590
601
|
username?: string | null;
|
|
591
602
|
/**
|
|
592
603
|
* Password to access Clickhouse.
|
|
593
604
|
*
|
|
594
|
-
* Currently a required field, but marked as optional because we may add
|
|
605
|
+
* Currently a required field, but marked as optional because we may add
|
|
606
|
+
* different authentication in the future.
|
|
595
607
|
*/
|
|
596
608
|
password?: string | null;
|
|
597
609
|
/** The Clickhouse database to connect to. */
|
|
@@ -635,7 +647,8 @@ interface EventBridgeConfigIn {
|
|
|
635
647
|
/**
|
|
636
648
|
* The region of the EventBridge bus.
|
|
637
649
|
*
|
|
638
|
-
* Currently a required field, but marked as optional because we may infer
|
|
650
|
+
* Currently a required field, but marked as optional because we may infer
|
|
651
|
+
* it from other fields in the future.
|
|
639
652
|
*/
|
|
640
653
|
region?: string | null;
|
|
641
654
|
}
|
|
@@ -680,7 +693,8 @@ interface OtelTracingConfigIn {
|
|
|
680
693
|
//#region src/models/postgresConfigIn.d.ts
|
|
681
694
|
interface PostgresConfigIn {
|
|
682
695
|
/**
|
|
683
|
-
* PostgreSQL connection URL, e.g.
|
|
696
|
+
* PostgreSQL connection URL, e.g.
|
|
697
|
+
* `postgres://user@host:5432/dbname?sslmode=require`.
|
|
684
698
|
*
|
|
685
699
|
* Do NOT embed a password here; use the `password` field instead.
|
|
686
700
|
*/
|
|
@@ -690,13 +704,16 @@ interface PostgresConfigIn {
|
|
|
690
704
|
/**
|
|
691
705
|
* Table to insert into. May be schema-qualified (e.g. `public.events`).
|
|
692
706
|
*
|
|
693
|
-
* Quote characters are not supported. Each dot-separated segment is automatically
|
|
707
|
+
* Quote characters are not supported. Each dot-separated segment is automatically
|
|
708
|
+
* double-quoted when the query is built, so `public.events` becomes `"public"."events"`.
|
|
694
709
|
*/
|
|
695
710
|
tableName: string;
|
|
696
711
|
/**
|
|
697
712
|
* PEM-encoded CA certificate used to verify the Postgres server's TLS certificate.
|
|
698
713
|
*
|
|
699
|
-
* Supply this to trust a private or self-signed CA when connecting with
|
|
714
|
+
* Supply this to trust a private or self-signed CA when connecting with
|
|
715
|
+
* `sslmode=verify-ca` or `sslmode=verify-full`. Without it, only the built-in
|
|
716
|
+
* public roots are trusted.
|
|
700
717
|
*/
|
|
701
718
|
sslRootCert?: string | null;
|
|
702
719
|
}
|
|
@@ -712,7 +729,8 @@ interface RabbitMqConfigIn {
|
|
|
712
729
|
/**
|
|
713
730
|
* Configuration parameters for defining a Redshift sink.
|
|
714
731
|
*
|
|
715
|
-
* For provisioned clusters, set `cluster_identifier` and `db_user`.
|
|
732
|
+
* For provisioned clusters, set `cluster_identifier` and `db_user`.
|
|
733
|
+
* For Redshift Serverless, set `workgroup_name`.
|
|
716
734
|
*/
|
|
717
735
|
interface RedshiftConfigIn {
|
|
718
736
|
/**
|
|
@@ -738,7 +756,8 @@ interface RedshiftConfigIn {
|
|
|
738
756
|
/**
|
|
739
757
|
* The region of the Redshift DB.
|
|
740
758
|
*
|
|
741
|
-
* Currently a required field, but marked as optional because we may infer
|
|
759
|
+
* Currently a required field, but marked as optional because we may infer
|
|
760
|
+
* it from other fields in the future.
|
|
742
761
|
*/
|
|
743
762
|
region?: string | null;
|
|
744
763
|
/** Required for provisioned clusters. */
|
|
@@ -785,7 +804,8 @@ interface S3ConfigIn {
|
|
|
785
804
|
/**
|
|
786
805
|
* The region of the S3 bucket
|
|
787
806
|
*
|
|
788
|
-
* Currently a required field, but marked as optional because we may infer
|
|
807
|
+
* Currently a required field, but marked as optional because we may infer
|
|
808
|
+
* it from other fields in the future.
|
|
789
809
|
*/
|
|
790
810
|
region?: string | null;
|
|
791
811
|
endpointUrl?: string | null;
|
|
@@ -803,14 +823,19 @@ interface S3ConfigIn {
|
|
|
803
823
|
/** Configuration parameters for defining a Snowflake sink. */
|
|
804
824
|
interface SnowflakeConfigIn {
|
|
805
825
|
/**
|
|
806
|
-
* PEM-encoded private key used for signing token-based requests
|
|
826
|
+
* PEM-encoded private key used for signing token-based requests
|
|
827
|
+
* to the Snowflake API.
|
|
807
828
|
*
|
|
808
829
|
* Beginning/end delimiters are not required.
|
|
809
830
|
*
|
|
810
|
-
* Currently a required field, but marked as optional because we may add
|
|
831
|
+
* Currently a required field, but marked as optional because we may add
|
|
832
|
+
* different authentication in the future.
|
|
811
833
|
*/
|
|
812
834
|
privateKey?: string | null;
|
|
813
|
-
/**
|
|
835
|
+
/**
|
|
836
|
+
* Snowflake account identifier, which includes both the organization and account
|
|
837
|
+
* IDs separated by a hyphen.
|
|
838
|
+
*/
|
|
814
839
|
accountIdentifier: string;
|
|
815
840
|
/** The Snowflake user id. */
|
|
816
841
|
userId: string;
|
|
@@ -841,7 +866,8 @@ interface SnsConfigIn {
|
|
|
841
866
|
/**
|
|
842
867
|
* The region of the SNS instance.
|
|
843
868
|
*
|
|
844
|
-
* Currently a required field, but marked as optional because we may infer
|
|
869
|
+
* Currently a required field, but marked as optional because we may infer
|
|
870
|
+
* it from other fields in the future.
|
|
845
871
|
*/
|
|
846
872
|
region?: string | null;
|
|
847
873
|
/**
|
|
@@ -874,7 +900,8 @@ interface SqsConfigIn {
|
|
|
874
900
|
/**
|
|
875
901
|
* The region of the SQS queue.
|
|
876
902
|
*
|
|
877
|
-
* Currently a required field, but marked as optional because we may infer
|
|
903
|
+
* Currently a required field, but marked as optional because we may infer
|
|
904
|
+
* it from other fields in the future.
|
|
878
905
|
*/
|
|
879
906
|
region?: string | null;
|
|
880
907
|
/**
|
|
@@ -907,9 +934,11 @@ interface _DestinationInFields {
|
|
|
907
934
|
/**
|
|
908
935
|
* Whether the destination will receive events.
|
|
909
936
|
*
|
|
910
|
-
* If the destination is `enabled`, events sent to the application will be
|
|
937
|
+
* If the destination is `enabled`, events sent to the application will be
|
|
938
|
+
* dispatched to the destination in order.
|
|
911
939
|
*
|
|
912
|
-
* If the destination is `disabled`, events will not be dispatched until the
|
|
940
|
+
* If the destination is `disabled`, events will not be dispatched until the
|
|
941
|
+
* destination is reenabled.
|
|
913
942
|
*/
|
|
914
943
|
status?: DestinationStatusIn;
|
|
915
944
|
/** How many events will be batched in a request to the destination. */
|
|
@@ -917,14 +946,21 @@ interface _DestinationInFields {
|
|
|
917
946
|
/**
|
|
918
947
|
* How long to wait before a batch of events is sent, if the `batchSize` is not reached.
|
|
919
948
|
*
|
|
920
|
-
* For example, with a `batchSize` of 100 and `maxWaitSecs` of 10, a request is sent after
|
|
949
|
+
* For example, with a `batchSize` of 100 and `maxWaitSecs` of 10, a request is sent after
|
|
950
|
+
* 10 seconds or 100 events, whichever comes first.
|
|
921
951
|
*
|
|
922
952
|
* Note that an empty batch is never sent to the destination.
|
|
923
953
|
*/
|
|
924
954
|
maxWaitSecs?: number;
|
|
925
|
-
/**
|
|
955
|
+
/**
|
|
956
|
+
* A list of event types that filter which events are dispatched to the destination.
|
|
957
|
+
* An empty list (or null) will not filter out any events.
|
|
958
|
+
*/
|
|
926
959
|
eventTypes?: string[];
|
|
927
|
-
/**
|
|
960
|
+
/**
|
|
961
|
+
* A list of channels that filter which events are dispatched to the destination.
|
|
962
|
+
* An empty list (or null) will not filter out any events.
|
|
963
|
+
*/
|
|
928
964
|
channels?: string[];
|
|
929
965
|
metadata?: {
|
|
930
966
|
[key: string]: string;
|
|
@@ -1076,6 +1112,7 @@ interface PostgresConfigOut {
|
|
|
1076
1112
|
//#endregion
|
|
1077
1113
|
//#region src/models/rabbitMqConfigOut.d.ts
|
|
1078
1114
|
interface RabbitMqConfigOut {
|
|
1115
|
+
uri: string;
|
|
1079
1116
|
routingKey: string;
|
|
1080
1117
|
}
|
|
1081
1118
|
//#endregion
|
|
@@ -1602,6 +1639,13 @@ interface BulkReplayIn {
|
|
|
1602
1639
|
statusCodeClass?: StatusCodeClass | null;
|
|
1603
1640
|
}
|
|
1604
1641
|
//#endregion
|
|
1642
|
+
//#region src/models/endpointAttemptStats.d.ts
|
|
1643
|
+
interface EndpointAttemptStats {
|
|
1644
|
+
success: number;
|
|
1645
|
+
fail: number;
|
|
1646
|
+
canceled: number;
|
|
1647
|
+
}
|
|
1648
|
+
//#endregion
|
|
1605
1649
|
//#region src/models/endpointHeadersIn.d.ts
|
|
1606
1650
|
interface EndpointHeadersIn {
|
|
1607
1651
|
headers: {
|
|
@@ -1863,6 +1907,12 @@ interface EndpointGetStatsOptions {
|
|
|
1863
1907
|
/** Filter the range to data ending by this date. */
|
|
1864
1908
|
until?: Date | null;
|
|
1865
1909
|
}
|
|
1910
|
+
interface EndpointGetAttemptStatsOptions {
|
|
1911
|
+
/** Filter the range to data starting from this date. */
|
|
1912
|
+
since?: Date | null;
|
|
1913
|
+
/** Filter the range to data ending by this date. */
|
|
1914
|
+
until?: Date | null;
|
|
1915
|
+
}
|
|
1866
1916
|
interface EndpointRecoverOptions {
|
|
1867
1917
|
idempotencyKey?: string;
|
|
1868
1918
|
}
|
|
@@ -1948,6 +1998,12 @@ declare class Endpoint {
|
|
|
1948
1998
|
bulkReplay(appId: string, endpointId: string, bulkReplayIn: BulkReplayIn, options?: EndpointBulkReplayOptions): Promise<ReplayOut>;
|
|
1949
1999
|
/** Get basic statistics for the endpoint. */
|
|
1950
2000
|
getStats(appId: string, endpointId: string, options?: EndpointGetStatsOptions): Promise<EndpointStats>;
|
|
2001
|
+
/**
|
|
2002
|
+
* Get basic statistics about attempted deliveries for the endpoint.
|
|
2003
|
+
*
|
|
2004
|
+
* Time windows are always rounded to hour granularity
|
|
2005
|
+
*/
|
|
2006
|
+
getAttemptStats(appId: string, endpointId: string, options?: EndpointGetAttemptStatsOptions): Promise<EndpointAttemptStats>;
|
|
1951
2007
|
/**
|
|
1952
2008
|
* Resend all failed messages since a given time.
|
|
1953
2009
|
*
|
|
@@ -2055,7 +2111,9 @@ declare class Environment {
|
|
|
2055
2111
|
/**
|
|
2056
2112
|
* Import a list of event types from webhooks defined in an OpenAPI spec.
|
|
2057
2113
|
*
|
|
2058
|
-
* The OpenAPI spec can be specified as either `spec` given the spec as a JSON object, or as `specRaw`
|
|
2114
|
+
* The OpenAPI spec can be specified as either `spec` given the spec as a JSON object, or as `specRaw`
|
|
2115
|
+
* (a `string`) which will be parsed as YAML or JSON by the server.
|
|
2116
|
+
* Sending neither or both is invalid, resulting in a `400` **Bad Request**.
|
|
2059
2117
|
*/
|
|
2060
2118
|
interface EventTypeImportOpenApiIn {
|
|
2061
2119
|
/** If `true`, return the event types that would be modified without actually modifying them. */
|
|
@@ -2142,7 +2200,10 @@ interface EventTypeImportOpenapiOptions {
|
|
|
2142
2200
|
idempotencyKey?: string;
|
|
2143
2201
|
}
|
|
2144
2202
|
interface EventTypeDeleteOptions {
|
|
2145
|
-
/**
|
|
2203
|
+
/**
|
|
2204
|
+
* By default event types are archived when "deleted". Passing this to `true` deletes them
|
|
2205
|
+
* entirely.
|
|
2206
|
+
*/
|
|
2146
2207
|
expunge?: boolean;
|
|
2147
2208
|
}
|
|
2148
2209
|
declare class EventType {
|
|
@@ -2196,7 +2257,8 @@ interface IngestSourceConsumerPortalAccessIn {
|
|
|
2196
2257
|
/**
|
|
2197
2258
|
* How long the token will be valid for, in seconds.
|
|
2198
2259
|
*
|
|
2199
|
-
* Valid values are between 1 hour and 7 days.
|
|
2260
|
+
* Valid values are between 1 hour and 7 days.
|
|
2261
|
+
* The default is 7 days.
|
|
2200
2262
|
*/
|
|
2201
2263
|
expiry?: number | null;
|
|
2202
2264
|
/** Whether the app portal should be in read-only mode. */
|
|
@@ -2291,7 +2353,8 @@ interface IngestEndpointSecretIn {
|
|
|
2291
2353
|
/**
|
|
2292
2354
|
* How long the old secret will be valid for, in seconds.
|
|
2293
2355
|
*
|
|
2294
|
-
* Valid values are between 0 (immediate expiry) and 7 days.
|
|
2356
|
+
* Valid values are between 0 (immediate expiry) and 7 days.
|
|
2357
|
+
* The default is 24 hours.
|
|
2295
2358
|
*/
|
|
2296
2359
|
gracePeriodSeconds?: number | null;
|
|
2297
2360
|
}
|
|
@@ -3292,7 +3355,8 @@ interface MessageIn {
|
|
|
3292
3355
|
/**
|
|
3293
3356
|
* Optionally creates a new application alongside the message.
|
|
3294
3357
|
*
|
|
3295
|
-
* If the application id or uid that is used in the path already exists,
|
|
3358
|
+
* If the application id or uid that is used in the path already exists,
|
|
3359
|
+
* this argument is ignored.
|
|
3296
3360
|
*/
|
|
3297
3361
|
application?: ApplicationIn | null;
|
|
3298
3362
|
/** List of free-form tags that can be filtered by when listing messages */
|
|
@@ -3302,12 +3366,19 @@ interface MessageIn {
|
|
|
3302
3366
|
/**
|
|
3303
3367
|
* The date and time at which the message will be delivered.
|
|
3304
3368
|
*
|
|
3305
|
-
* Note that this time is best-effort-only. Must be at least one minute
|
|
3369
|
+
* Note that this time is best-effort-only. Must be at least one minute
|
|
3370
|
+
* and no more than 24 hours in the future.
|
|
3306
3371
|
*/
|
|
3307
3372
|
deliverAt?: Date | null;
|
|
3308
|
-
/**
|
|
3373
|
+
/**
|
|
3374
|
+
* Optional number of days to retain the message payload. Defaults to 90.
|
|
3375
|
+
* Note that this is mutually exclusive with `payloadRetentionHours`.
|
|
3376
|
+
*/
|
|
3309
3377
|
payloadRetentionPeriod?: number | null;
|
|
3310
|
-
/**
|
|
3378
|
+
/**
|
|
3379
|
+
* Optional number of hours to retain the message payload. Note that
|
|
3380
|
+
* this is mutually exclusive with `payloadRetentionPeriod`.
|
|
3381
|
+
*/
|
|
3311
3382
|
payloadRetentionHours?: number | null;
|
|
3312
3383
|
}
|
|
3313
3384
|
//#endregion
|
|
@@ -3326,7 +3397,8 @@ interface MessageListOptions {
|
|
|
3326
3397
|
/**
|
|
3327
3398
|
* When `true` message payloads are included in the response.
|
|
3328
3399
|
*
|
|
3329
|
-
* Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request
|
|
3400
|
+
* Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request
|
|
3401
|
+
* without specifying this parameter.
|
|
3330
3402
|
*/
|
|
3331
3403
|
withContent?: boolean;
|
|
3332
3404
|
/** Filter messages matching the provided tag. */
|
|
@@ -3338,7 +3410,8 @@ interface MessageCreateOptions {
|
|
|
3338
3410
|
/**
|
|
3339
3411
|
* When `true`, message payloads are included in the response.
|
|
3340
3412
|
*
|
|
3341
|
-
* Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request
|
|
3413
|
+
* Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request
|
|
3414
|
+
* without specifying this parameter.
|
|
3342
3415
|
*/
|
|
3343
3416
|
withContent?: boolean;
|
|
3344
3417
|
idempotencyKey?: string;
|
|
@@ -3350,7 +3423,8 @@ interface MessageGetOptions {
|
|
|
3350
3423
|
/**
|
|
3351
3424
|
* When `true` message payloads are included in the response.
|
|
3352
3425
|
*
|
|
3353
|
-
* Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request
|
|
3426
|
+
* Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request
|
|
3427
|
+
* without specifying this parameter.
|
|
3354
3428
|
*/
|
|
3355
3429
|
withContent?: boolean;
|
|
3356
3430
|
}
|
|
@@ -3460,7 +3534,10 @@ declare enum MessageStatusText {
|
|
|
3460
3534
|
}
|
|
3461
3535
|
//#endregion
|
|
3462
3536
|
//#region src/models/endpointMessageOut.d.ts
|
|
3463
|
-
/**
|
|
3537
|
+
/**
|
|
3538
|
+
* A model containing information on a given message plus additional fields on the last attempt for
|
|
3539
|
+
* that message.
|
|
3540
|
+
*/
|
|
3464
3541
|
interface EndpointMessageOut {
|
|
3465
3542
|
status: MessageStatus;
|
|
3466
3543
|
statusText: MessageStatusText;
|
|
@@ -3581,7 +3658,8 @@ interface MessageAttemptListByEndpointOptions {
|
|
|
3581
3658
|
/**
|
|
3582
3659
|
* When `true` attempt content is included in the response.
|
|
3583
3660
|
*
|
|
3584
|
-
* Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request
|
|
3661
|
+
* Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request
|
|
3662
|
+
* without specifying this parameter.
|
|
3585
3663
|
*/
|
|
3586
3664
|
withContent?: boolean;
|
|
3587
3665
|
/**
|
|
@@ -3621,7 +3699,8 @@ interface MessageAttemptListByMsgOptions {
|
|
|
3621
3699
|
/**
|
|
3622
3700
|
* When `true` attempt content is included in the response.
|
|
3623
3701
|
*
|
|
3624
|
-
* Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request
|
|
3702
|
+
* Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request
|
|
3703
|
+
* without specifying this parameter.
|
|
3625
3704
|
*/
|
|
3626
3705
|
withContent?: boolean;
|
|
3627
3706
|
/**
|
|
@@ -3651,7 +3730,8 @@ interface MessageAttemptListAttemptedMessagesOptions {
|
|
|
3651
3730
|
/**
|
|
3652
3731
|
* When `true` message payloads are included in the response.
|
|
3653
3732
|
*
|
|
3654
|
-
* Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request
|
|
3733
|
+
* Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request
|
|
3734
|
+
* without specifying this parameter.
|
|
3655
3735
|
*/
|
|
3656
3736
|
withContent?: boolean;
|
|
3657
3737
|
/**
|
|
@@ -3820,7 +3900,8 @@ interface OperationalWebhookEndpointSecretIn {
|
|
|
3820
3900
|
/**
|
|
3821
3901
|
* How long the old secret will be valid for, in seconds.
|
|
3822
3902
|
*
|
|
3823
|
-
* Valid values are between 0 (immediate expiry) and 7 days.
|
|
3903
|
+
* Valid values are between 0 (immediate expiry) and 7 days.
|
|
3904
|
+
* The default is 24 hours.
|
|
3824
3905
|
*/
|
|
3825
3906
|
gracePeriodSeconds?: number | null;
|
|
3826
3907
|
}
|
|
@@ -3932,17 +4013,17 @@ interface AppUsageStatsIn {
|
|
|
3932
4013
|
//#endregion
|
|
3933
4014
|
//#region src/models/appUsageStatsOut.d.ts
|
|
3934
4015
|
interface AppUsageStatsOut {
|
|
4016
|
+
/** The QueueBackgroundTask's ID. */
|
|
4017
|
+
id: string;
|
|
4018
|
+
status: BackgroundTaskStatus;
|
|
4019
|
+
task: BackgroundTaskType;
|
|
4020
|
+
updatedAt: Date;
|
|
3935
4021
|
/**
|
|
3936
4022
|
* Any app IDs or UIDs received in the request that weren't found.
|
|
3937
4023
|
*
|
|
3938
4024
|
* Stats will be produced for all the others.
|
|
3939
4025
|
*/
|
|
3940
4026
|
unresolvedAppIds: string[];
|
|
3941
|
-
/** The QueueBackgroundTask's ID. */
|
|
3942
|
-
id: string;
|
|
3943
|
-
status: BackgroundTaskStatus;
|
|
3944
|
-
task: BackgroundTaskType;
|
|
3945
|
-
updatedAt: Date;
|
|
3946
4027
|
}
|
|
3947
4028
|
//#endregion
|
|
3948
4029
|
//#region src/api/statistics.d.ts
|
|
@@ -4108,7 +4189,8 @@ interface CreateStreamEventsIn {
|
|
|
4108
4189
|
/**
|
|
4109
4190
|
* Optionally creates a new Stream alongside the events.
|
|
4110
4191
|
*
|
|
4111
|
-
* If the stream id or uid that is used in the path already exists,
|
|
4192
|
+
* If the stream id or uid that is used in the path already exists,
|
|
4193
|
+
* this argument is ignored.
|
|
4112
4194
|
*/
|
|
4113
4195
|
stream?: StreamIn | null;
|
|
4114
4196
|
}
|
|
@@ -4296,7 +4378,8 @@ interface _StreamSinkInFields {
|
|
|
4296
4378
|
/**
|
|
4297
4379
|
* Whether the sink will receive events.
|
|
4298
4380
|
*
|
|
4299
|
-
* If the sink is `enabled`, any events posted to the stream will be
|
|
4381
|
+
* If the sink is `enabled`, any events posted to the stream will be
|
|
4382
|
+
* dispatched to the Sink in the same order that events were posted to the stream.
|
|
4300
4383
|
*
|
|
4301
4384
|
* If the sink is `disabled`, events will not be dispatched to the sink until the sink is reenabled.
|
|
4302
4385
|
*/
|
|
@@ -4311,7 +4394,10 @@ interface _StreamSinkInFields {
|
|
|
4311
4394
|
* Note that we will never send an empty batch of events to the Sink.
|
|
4312
4395
|
*/
|
|
4313
4396
|
maxWaitSecs?: number;
|
|
4314
|
-
/**
|
|
4397
|
+
/**
|
|
4398
|
+
* A list of event types that filter which events are dispatched to the Sink. An empty list (or null) will not filter out
|
|
4399
|
+
* any events.
|
|
4400
|
+
*/
|
|
4315
4401
|
eventTypes?: string[];
|
|
4316
4402
|
channels?: string[];
|
|
4317
4403
|
metadata?: {
|
|
@@ -4853,5 +4939,5 @@ declare class Svix {
|
|
|
4853
4939
|
get streaming(): Streaming;
|
|
4854
4940
|
}
|
|
4855
4941
|
//#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 };
|
|
4942
|
+
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 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
4943
|
//# sourceMappingURL=index.d.mts.map
|