svix 2.3.0 → 2.5.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 +1248 -798
- package/dist/index.d.mts.map +1 -1
- package/dist/index.mjs +4500 -3712
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
- package/src/api/autoconfigSubscription.ts +53 -0
- package/src/api/destination.ts +133 -0
- package/src/api/destinationTransformation.ts +55 -0
- package/src/api_internal/autoconfigSubscription.ts +40 -0
- package/src/api_internal/autoconfigSubscriptionDestination.ts +27 -0
- package/src/api_internal/autoconfigSubscriptionEndpoint.ts +27 -0
- package/src/api_internal/endpoint.ts +3 -3
- package/src/api_internal/{endpointAutoConfig.ts → endpointAutoConfigDeprecated.ts} +1 -1
- package/src/autoconfig.test.ts +162 -3
- package/src/autoconfig.ts +88 -26
- package/src/autoconfigConsumer.ts +90 -16
- package/src/index.ts +10 -0
- package/src/models/autoConfigOut.ts +26 -0
- package/src/models/autoConfigSubscriptionOut.ts +38 -0
- package/src/models/destinationIn.ts +303 -0
- package/src/models/destinationOut.ts +295 -0
- package/src/models/destinationPatch.ts +302 -0
- package/src/models/destinationStatus.ts +18 -0
- package/src/models/destinationStatusIn.ts +16 -0
- package/src/models/destinationTransformIn.ts +19 -0
- package/src/models/destinationTransformationOut.ts +22 -0
- package/src/models/eventBridgeConfigIn.ts +14 -2
- package/src/models/eventBridgeConfigOut.ts +7 -1
- package/src/models/eventBridgeConfigPatch.ts +6 -0
- package/src/models/fifoEndpointConfigIn.ts +25 -0
- package/src/models/index.ts +13 -0
- package/src/models/ingestSourceIn.ts +12 -0
- package/src/models/ingestSourceOut.ts +12 -0
- package/src/models/listResponseDestinationOut.ts +31 -0
- package/src/models/mergeConfig.ts +19 -0
- package/src/models/mergeConfigOut.ts +15 -0
- package/src/models/redshiftConfigIn.ts +14 -2
- package/src/models/redshiftConfigOut.ts +7 -1
- package/src/models/redshiftConfigPatch.ts +6 -0
- package/src/models/rotateSubscriptionIn2.ts +29 -0
- package/src/models/s3ConfigIn.ts +1 -1
- package/src/models/snsConfigIn.ts +14 -2
- package/src/models/snsConfigOut.ts +7 -1
- package/src/models/snsConfigPatch.ts +6 -0
- package/src/models/sqsConfigIn.ts +14 -2
- package/src/models/sqsConfigOut.ts +7 -1
- package/src/models/sqsConfigPatch.ts +6 -0
- package/src/models/status.ts +16 -0
- package/src/models/streamSinkOut.ts +15 -0
- package/src/request.ts +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -324,6 +324,52 @@ declare class Authentication {
|
|
|
324
324
|
getStreamPollerToken(streamId: string, sinkId: string): Promise<ApiTokenOut>;
|
|
325
325
|
}
|
|
326
326
|
//#endregion
|
|
327
|
+
//#region src/models/autoConfigOut.d.ts
|
|
328
|
+
interface AutoConfigOut {
|
|
329
|
+
createdAt: Date;
|
|
330
|
+
token: string;
|
|
331
|
+
/** The AutoConfigSubscription's ID. */
|
|
332
|
+
id: string;
|
|
333
|
+
}
|
|
334
|
+
//#endregion
|
|
335
|
+
//#region src/models/endpointSecretRotateIn.d.ts
|
|
336
|
+
interface EndpointSecretRotateIn {
|
|
337
|
+
/**
|
|
338
|
+
* The endpoint's verification secret.
|
|
339
|
+
*
|
|
340
|
+
* Format: `base64` encoded random bytes optionally prefixed with `whsec_`.
|
|
341
|
+
* It is recommended to not set this and let the server generate the secret.
|
|
342
|
+
*/
|
|
343
|
+
key?: string | null;
|
|
344
|
+
/**
|
|
345
|
+
* How long the old secret will be valid for, in seconds.
|
|
346
|
+
*
|
|
347
|
+
* Valid values are between 0 (immediate expiry) and 7 days. The default is 24 hours.
|
|
348
|
+
*/
|
|
349
|
+
gracePeriodSeconds?: number | null;
|
|
350
|
+
}
|
|
351
|
+
//#endregion
|
|
352
|
+
//#region src/models/rotateSubscriptionIn2.d.ts
|
|
353
|
+
interface RotateSubscriptionIn2 {
|
|
354
|
+
signingSecret?: EndpointSecretRotateIn | null;
|
|
355
|
+
}
|
|
356
|
+
//#endregion
|
|
357
|
+
//#region src/api/autoconfigSubscription.d.ts
|
|
358
|
+
interface AutoconfigSubscriptionCreateOptions {
|
|
359
|
+
idempotencyKey?: string;
|
|
360
|
+
}
|
|
361
|
+
interface AutoconfigSubscriptionRotateOptions {
|
|
362
|
+
idempotencyKey?: string;
|
|
363
|
+
}
|
|
364
|
+
declare class AutoconfigSubscription {
|
|
365
|
+
private readonly requestCtx;
|
|
366
|
+
constructor(requestCtx: SvixRequestContext);
|
|
367
|
+
/** Create an AutoConfig subscription. */
|
|
368
|
+
create(appId: string, options?: AutoconfigSubscriptionCreateOptions): Promise<AutoConfigOut>;
|
|
369
|
+
/** Rotate the auth token and signing secret for an AutoConfig subscription. */
|
|
370
|
+
rotate(appId: string, autoconfigId: string, rotateSubscriptionIn2?: RotateSubscriptionIn2, options?: AutoconfigSubscriptionRotateOptions): Promise<AutoConfigOut>;
|
|
371
|
+
}
|
|
372
|
+
//#endregion
|
|
327
373
|
//#region src/models/backgroundTaskStatus.d.ts
|
|
328
374
|
declare enum BackgroundTaskStatus {
|
|
329
375
|
Running = "running",
|
|
@@ -510,206 +556,1173 @@ declare class Connector {
|
|
|
510
556
|
patch(connectorId: string, connectorPatch: ConnectorPatch): Promise<ConnectorOut>;
|
|
511
557
|
}
|
|
512
558
|
//#endregion
|
|
513
|
-
//#region src/models/
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
declare enum MessageStatus {
|
|
524
|
-
Success = 0,
|
|
525
|
-
Pending = 1,
|
|
526
|
-
Fail = 2,
|
|
527
|
-
Sending = 3,
|
|
528
|
-
Canceled = 4
|
|
529
|
-
}
|
|
530
|
-
//#endregion
|
|
531
|
-
//#region src/models/statusCodeClass.d.ts
|
|
532
|
-
/**
|
|
533
|
-
* The different classes of HTTP status codes:
|
|
534
|
-
*
|
|
535
|
-
* - CodeNone = 0
|
|
536
|
-
* - Code1xx = 100
|
|
537
|
-
* - Code2xx = 200
|
|
538
|
-
* - Code3xx = 300
|
|
539
|
-
* - Code4xx = 400
|
|
540
|
-
* - Code5xx = 500
|
|
541
|
-
*/
|
|
542
|
-
declare enum StatusCodeClass {
|
|
543
|
-
CodeNone = 0,
|
|
544
|
-
Code1xx = 100,
|
|
545
|
-
Code2xx = 200,
|
|
546
|
-
Code3xx = 300,
|
|
547
|
-
Code4xx = 400,
|
|
548
|
-
Code5xx = 500
|
|
549
|
-
}
|
|
550
|
-
//#endregion
|
|
551
|
-
//#region src/models/bulkReplayIn.d.ts
|
|
552
|
-
interface BulkReplayIn {
|
|
553
|
-
since: Date;
|
|
554
|
-
until?: Date | null;
|
|
555
|
-
eventTypes?: string[] | null;
|
|
556
|
-
channel?: string | null;
|
|
557
|
-
tag?: string | null;
|
|
558
|
-
status?: MessageStatus | null;
|
|
559
|
-
statusCodeClass?: StatusCodeClass | null;
|
|
560
|
-
}
|
|
561
|
-
//#endregion
|
|
562
|
-
//#region src/models/endpointHeadersIn.d.ts
|
|
563
|
-
interface EndpointHeadersIn {
|
|
564
|
-
headers: {
|
|
565
|
-
[key: string]: string;
|
|
566
|
-
};
|
|
567
|
-
}
|
|
568
|
-
//#endregion
|
|
569
|
-
//#region src/models/endpointHeadersOut.d.ts
|
|
570
|
-
/**
|
|
571
|
-
* The value of the headers is returned in the `headers` field.
|
|
572
|
-
*
|
|
573
|
-
* Sensitive headers that have been redacted are returned in the sensitive field.
|
|
574
|
-
*/
|
|
575
|
-
interface EndpointHeadersOut {
|
|
576
|
-
headers: {
|
|
577
|
-
[key: string]: string;
|
|
578
|
-
};
|
|
579
|
-
sensitive: string[];
|
|
559
|
+
//#region src/models/azureBlobStorageConfigIn.d.ts
|
|
560
|
+
interface AzureBlobStorageConfigIn {
|
|
561
|
+
container: string;
|
|
562
|
+
account: string;
|
|
563
|
+
/**
|
|
564
|
+
* Access key.
|
|
565
|
+
*
|
|
566
|
+
* Currently a required field, but marked as optional because we may add different authentication in the future.
|
|
567
|
+
*/
|
|
568
|
+
accessKey?: string | null;
|
|
580
569
|
}
|
|
581
570
|
//#endregion
|
|
582
|
-
//#region src/models/
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
571
|
+
//#region src/models/bigQueryConfigIn.d.ts
|
|
572
|
+
/** Configuration for a Google Cloud BigQuery sink. */
|
|
573
|
+
interface BigQueryConfigIn {
|
|
574
|
+
projectId: string;
|
|
575
|
+
datasetId: string;
|
|
576
|
+
tableId: string;
|
|
577
|
+
/** Google Cloud Credentials JSON Object as a string. */
|
|
578
|
+
credentials: string;
|
|
589
579
|
}
|
|
590
580
|
//#endregion
|
|
591
|
-
//#region src/models/
|
|
592
|
-
interface
|
|
581
|
+
//#region src/models/clickhouseConfigIn.d.ts
|
|
582
|
+
interface ClickhouseConfigIn {
|
|
583
|
+
/** The HTTP URL of the ClickHouse server (e.g. `https://my_clickhouse:8443`). */
|
|
593
584
|
url: string;
|
|
594
|
-
description?: string;
|
|
595
585
|
/**
|
|
596
|
-
*
|
|
586
|
+
* Username to access Clickhouse.
|
|
597
587
|
*
|
|
598
|
-
*
|
|
588
|
+
* Currently a required field, but marked as optional because we may add different authentication in the future.
|
|
599
589
|
*/
|
|
600
|
-
|
|
601
|
-
/** Optional unique identifier for the endpoint. */
|
|
602
|
-
uid?: string | null;
|
|
603
|
-
disabled?: boolean;
|
|
604
|
-
eventTypes?: string[] | null;
|
|
605
|
-
/** List of message channels this endpoint listens to (omit for all). */
|
|
606
|
-
channels?: string[] | null;
|
|
590
|
+
username?: string | null;
|
|
607
591
|
/**
|
|
608
|
-
*
|
|
592
|
+
* Password to access Clickhouse.
|
|
609
593
|
*
|
|
610
|
-
*
|
|
611
|
-
* It is recommended to not set this and let the server generate the secret.
|
|
594
|
+
* Currently a required field, but marked as optional because we may add different authentication in the future.
|
|
612
595
|
*/
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
[key: string]: string;
|
|
619
|
-
} | null;
|
|
596
|
+
password?: string | null;
|
|
597
|
+
/** The Clickhouse database to connect to. */
|
|
598
|
+
database?: string;
|
|
599
|
+
/** The Clickhouse table to write to. */
|
|
600
|
+
tableName: string;
|
|
620
601
|
}
|
|
621
602
|
//#endregion
|
|
622
|
-
//#region src/models/
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
metadata: {
|
|
627
|
-
[key: string]: string;
|
|
628
|
-
};
|
|
629
|
-
url: string;
|
|
630
|
-
description: string;
|
|
631
|
-
/**
|
|
632
|
-
* Maximum messages per second to send to this endpoint.
|
|
633
|
-
*
|
|
634
|
-
* Outgoing messages will be throttled to this rate.
|
|
635
|
-
*/
|
|
636
|
-
throttleRate?: number | null;
|
|
637
|
-
/** Optional unique identifier for the endpoint. */
|
|
638
|
-
uid?: string | null;
|
|
639
|
-
disabled?: boolean;
|
|
640
|
-
eventTypes?: string[] | null;
|
|
641
|
-
/** List of message channels this endpoint listens to (omit for all). */
|
|
642
|
-
channels?: string[] | null;
|
|
643
|
-
createdAt: Date;
|
|
644
|
-
updatedAt: Date;
|
|
603
|
+
//#region src/models/destinationStatusIn.d.ts
|
|
604
|
+
declare enum DestinationStatusIn {
|
|
605
|
+
Enabled = "enabled",
|
|
606
|
+
Disabled = "disabled"
|
|
645
607
|
}
|
|
646
608
|
//#endregion
|
|
647
|
-
//#region src/models/
|
|
648
|
-
interface
|
|
649
|
-
|
|
609
|
+
//#region src/models/eventBridgeConfigIn.d.ts
|
|
610
|
+
interface EventBridgeConfigIn {
|
|
611
|
+
/** The name or ARN of the event bus to receive the event */
|
|
612
|
+
eventBusName: string;
|
|
613
|
+
/** Free-form string, with a maximum of 128 characters */
|
|
614
|
+
detailType?: string;
|
|
650
615
|
/**
|
|
651
|
-
*
|
|
616
|
+
* Access key ID.
|
|
652
617
|
*
|
|
653
|
-
*
|
|
618
|
+
* Required (along with `secret_access_key`) if `role_arn` is blank.
|
|
654
619
|
*/
|
|
655
|
-
|
|
656
|
-
/** The Endpoint's UID. */
|
|
657
|
-
uid?: string | null;
|
|
658
|
-
url?: string;
|
|
659
|
-
disabled?: boolean;
|
|
660
|
-
eventTypes?: string[] | null;
|
|
661
|
-
channels?: string[] | null;
|
|
662
|
-
metadata?: {
|
|
663
|
-
[key: string]: string;
|
|
664
|
-
};
|
|
665
|
-
}
|
|
666
|
-
//#endregion
|
|
667
|
-
//#region src/models/endpointSecretOut.d.ts
|
|
668
|
-
interface EndpointSecretOut {
|
|
620
|
+
accessKeyId?: string | null;
|
|
669
621
|
/**
|
|
670
|
-
*
|
|
622
|
+
* Secret access key.
|
|
671
623
|
*
|
|
672
|
-
*
|
|
673
|
-
* It is recommended to not set this and let the server generate the secret.
|
|
624
|
+
* Required (along with `access_key_id`) if `role_arn` is blank.
|
|
674
625
|
*/
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
//#region src/models/endpointSecretRotateIn.d.ts
|
|
679
|
-
interface EndpointSecretRotateIn {
|
|
626
|
+
secretAccessKey?: string | null;
|
|
627
|
+
/** Role ARN for delegated authentication */
|
|
628
|
+
roleArn?: string | null;
|
|
680
629
|
/**
|
|
681
|
-
*
|
|
630
|
+
* Shared secret passed as the STS ExternalId.
|
|
682
631
|
*
|
|
683
|
-
*
|
|
684
|
-
* It is recommended to not set this and let the server generate the secret.
|
|
632
|
+
* Can only be set if `role_arn` is Some
|
|
685
633
|
*/
|
|
686
|
-
|
|
634
|
+
externalId?: string | null;
|
|
687
635
|
/**
|
|
688
|
-
*
|
|
636
|
+
* The region of the EventBridge bus.
|
|
689
637
|
*
|
|
690
|
-
*
|
|
638
|
+
* Currently a required field, but marked as optional because we may infer it from other fields in the future.
|
|
691
639
|
*/
|
|
692
|
-
|
|
693
|
-
}
|
|
694
|
-
//#endregion
|
|
695
|
-
//#region src/models/endpointStats.d.ts
|
|
696
|
-
interface EndpointStats {
|
|
697
|
-
success: number;
|
|
698
|
-
pending: number;
|
|
699
|
-
sending: number;
|
|
700
|
-
fail: number;
|
|
701
|
-
canceled: number;
|
|
640
|
+
region?: string | null;
|
|
702
641
|
}
|
|
703
642
|
//#endregion
|
|
704
|
-
//#region src/models/
|
|
705
|
-
interface
|
|
706
|
-
|
|
707
|
-
|
|
643
|
+
//#region src/models/fifoEndpointConfigIn.d.ts
|
|
644
|
+
interface FifoEndpointConfigIn {
|
|
645
|
+
url: string;
|
|
646
|
+
headers?: {
|
|
647
|
+
[key: string]: string;
|
|
648
|
+
};
|
|
649
|
+
key?: string | null;
|
|
708
650
|
}
|
|
709
651
|
//#endregion
|
|
710
|
-
//#region src/models/
|
|
711
|
-
interface
|
|
712
|
-
|
|
652
|
+
//#region src/models/googleCloudPubSubConfigIn.d.ts
|
|
653
|
+
interface GoogleCloudPubSubConfigIn {
|
|
654
|
+
projectId: string;
|
|
655
|
+
topicId: string;
|
|
656
|
+
/** Google Cloud Credentials JSON Object as a string. */
|
|
657
|
+
credentials: string;
|
|
658
|
+
}
|
|
659
|
+
//#endregion
|
|
660
|
+
//#region src/models/googleCloudStorageConfigIn.d.ts
|
|
661
|
+
/**
|
|
662
|
+
* Configuration for a Google Cloud Storage sink.
|
|
663
|
+
*
|
|
664
|
+
* Write stream events into the named bucket using the supplied Google Cloud credentials.
|
|
665
|
+
*/
|
|
666
|
+
interface GoogleCloudStorageConfigIn {
|
|
667
|
+
bucket: string;
|
|
668
|
+
/** Google Cloud Credentials JSON Object as a string. */
|
|
669
|
+
credentials: string;
|
|
670
|
+
}
|
|
671
|
+
//#endregion
|
|
672
|
+
//#region src/models/otelTracingConfigIn.d.ts
|
|
673
|
+
interface OtelTracingConfigIn {
|
|
674
|
+
url: string;
|
|
675
|
+
headers?: {
|
|
676
|
+
[key: string]: string;
|
|
677
|
+
};
|
|
678
|
+
}
|
|
679
|
+
//#endregion
|
|
680
|
+
//#region src/models/postgresConfigIn.d.ts
|
|
681
|
+
interface PostgresConfigIn {
|
|
682
|
+
/**
|
|
683
|
+
* PostgreSQL connection URL, e.g. `postgres://user@host:5432/dbname?sslmode=require`.
|
|
684
|
+
*
|
|
685
|
+
* Do NOT embed a password here; use the `password` field instead.
|
|
686
|
+
*/
|
|
687
|
+
url: string;
|
|
688
|
+
/** Password for the connection. */
|
|
689
|
+
password?: string | null;
|
|
690
|
+
/**
|
|
691
|
+
* Table to insert into. May be schema-qualified (e.g. `public.events`).
|
|
692
|
+
*
|
|
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"`.
|
|
694
|
+
*/
|
|
695
|
+
tableName: string;
|
|
696
|
+
/**
|
|
697
|
+
* PEM-encoded CA certificate used to verify the Postgres server's TLS certificate.
|
|
698
|
+
*
|
|
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.
|
|
700
|
+
*/
|
|
701
|
+
sslRootCert?: string | null;
|
|
702
|
+
}
|
|
703
|
+
//#endregion
|
|
704
|
+
//#region src/models/rabbitMqConfigIn.d.ts
|
|
705
|
+
/** Configuration for a RabbitMq sink. */
|
|
706
|
+
interface RabbitMqConfigIn {
|
|
707
|
+
uri: string;
|
|
708
|
+
routingKey: string;
|
|
709
|
+
}
|
|
710
|
+
//#endregion
|
|
711
|
+
//#region src/models/redshiftConfigIn.d.ts
|
|
712
|
+
/**
|
|
713
|
+
* Configuration parameters for defining a Redshift sink.
|
|
714
|
+
*
|
|
715
|
+
* For provisioned clusters, set `cluster_identifier` and `db_user`. For Redshift Serverless, set `workgroup_name`.
|
|
716
|
+
*/
|
|
717
|
+
interface RedshiftConfigIn {
|
|
718
|
+
/**
|
|
719
|
+
* Access key ID.
|
|
720
|
+
*
|
|
721
|
+
* Required (along with `secret_access_key`) if `role_arn` is blank.
|
|
722
|
+
*/
|
|
723
|
+
accessKeyId?: string | null;
|
|
724
|
+
/**
|
|
725
|
+
* Secret access key.
|
|
726
|
+
*
|
|
727
|
+
* Required (along with `access_key_id`) if `role_arn` is blank.
|
|
728
|
+
*/
|
|
729
|
+
secretAccessKey?: string | null;
|
|
730
|
+
/** Role ARN for delegated authentication */
|
|
731
|
+
roleArn?: string | null;
|
|
732
|
+
/**
|
|
733
|
+
* Shared secret passed as the STS ExternalId.
|
|
734
|
+
*
|
|
735
|
+
* Can only be set if `role_arn` is Some
|
|
736
|
+
*/
|
|
737
|
+
externalId?: string | null;
|
|
738
|
+
/**
|
|
739
|
+
* The region of the Redshift DB.
|
|
740
|
+
*
|
|
741
|
+
* Currently a required field, but marked as optional because we may infer it from other fields in the future.
|
|
742
|
+
*/
|
|
743
|
+
region?: string | null;
|
|
744
|
+
/** Required for provisioned clusters. */
|
|
745
|
+
clusterIdentifier?: string | null;
|
|
746
|
+
/** Required for provisioned clusters. */
|
|
747
|
+
dbUser?: string | null;
|
|
748
|
+
/** Required for Redshift Serverless. */
|
|
749
|
+
workgroupName?: string | null;
|
|
750
|
+
/**
|
|
751
|
+
* Database name.
|
|
752
|
+
*
|
|
753
|
+
* Only required if not using transformations.
|
|
754
|
+
*/
|
|
755
|
+
dbName?: string;
|
|
756
|
+
/**
|
|
757
|
+
* Schema name.
|
|
758
|
+
*
|
|
759
|
+
* Only used if not using transformations.
|
|
760
|
+
*/
|
|
761
|
+
schemaName?: string | null;
|
|
762
|
+
/**
|
|
763
|
+
* Table name.
|
|
764
|
+
*
|
|
765
|
+
* Only required if not using transformations.
|
|
766
|
+
*/
|
|
767
|
+
tableName?: string;
|
|
768
|
+
}
|
|
769
|
+
//#endregion
|
|
770
|
+
//#region src/models/s3ConfigIn.d.ts
|
|
771
|
+
interface S3ConfigIn {
|
|
772
|
+
bucket: string;
|
|
773
|
+
/**
|
|
774
|
+
* Access key ID.
|
|
775
|
+
*
|
|
776
|
+
* Required (along with `secret_access_key`) if `role_arn` is null
|
|
777
|
+
*/
|
|
778
|
+
accessKeyId?: string | null;
|
|
779
|
+
/**
|
|
780
|
+
* Secret access key.
|
|
781
|
+
*
|
|
782
|
+
* Required (along with `access_key_id`) if `role_arn` is null
|
|
783
|
+
*/
|
|
784
|
+
secretAccessKey?: string | null;
|
|
785
|
+
/**
|
|
786
|
+
* The region of the S3 bucket
|
|
787
|
+
*
|
|
788
|
+
* Currently a required field, but marked as optional because we may infer it from other fields in the future.
|
|
789
|
+
*/
|
|
790
|
+
region?: string | null;
|
|
791
|
+
endpointUrl?: string | null;
|
|
792
|
+
/** Role ARN for delegated authentication */
|
|
793
|
+
roleArn?: string | null;
|
|
794
|
+
/**
|
|
795
|
+
* Shared secret passed as the STS ExternalId.
|
|
796
|
+
*
|
|
797
|
+
* Recommended if `role_arn` is not null.
|
|
798
|
+
*/
|
|
799
|
+
externalId?: string | null;
|
|
800
|
+
}
|
|
801
|
+
//#endregion
|
|
802
|
+
//#region src/models/snowflakeConfigIn.d.ts
|
|
803
|
+
/** Configuration parameters for defining a Snowflake sink. */
|
|
804
|
+
interface SnowflakeConfigIn {
|
|
805
|
+
/**
|
|
806
|
+
* PEM-encoded private key used for signing token-based requests to the Snowflake API.
|
|
807
|
+
*
|
|
808
|
+
* Beginning/end delimiters are not required.
|
|
809
|
+
*
|
|
810
|
+
* Currently a required field, but marked as optional because we may add different authentication in the future.
|
|
811
|
+
*/
|
|
812
|
+
privateKey?: string | null;
|
|
813
|
+
/** Snowflake account identifier, which includes both the organization and account IDs separated by a hyphen. */
|
|
814
|
+
accountIdentifier: string;
|
|
815
|
+
/** The Snowflake user id. */
|
|
816
|
+
userId: string;
|
|
817
|
+
/**
|
|
818
|
+
* Database name.
|
|
819
|
+
*
|
|
820
|
+
* Only required if not using transformations.
|
|
821
|
+
*/
|
|
822
|
+
dbName?: string;
|
|
823
|
+
/**
|
|
824
|
+
* Schema name.
|
|
825
|
+
*
|
|
826
|
+
* Only required if not using transformations.
|
|
827
|
+
*/
|
|
828
|
+
schemaName?: string;
|
|
829
|
+
/**
|
|
830
|
+
* Table name.
|
|
831
|
+
*
|
|
832
|
+
* Only required if not using transformations.
|
|
833
|
+
*/
|
|
834
|
+
tableName?: string;
|
|
835
|
+
}
|
|
836
|
+
//#endregion
|
|
837
|
+
//#region src/models/snsConfigIn.d.ts
|
|
838
|
+
/** Configuration for a SNS sink. */
|
|
839
|
+
interface SnsConfigIn {
|
|
840
|
+
topicArn: string;
|
|
841
|
+
/**
|
|
842
|
+
* The region of the SNS instance.
|
|
843
|
+
*
|
|
844
|
+
* Currently a required field, but marked as optional because we may infer it from other fields in the future.
|
|
845
|
+
*/
|
|
846
|
+
region?: string | null;
|
|
847
|
+
/**
|
|
848
|
+
* Access key ID.
|
|
849
|
+
*
|
|
850
|
+
* Required (along with `secret_access_key`) if `role_arn` is None
|
|
851
|
+
*/
|
|
852
|
+
accessKeyId?: string | null;
|
|
853
|
+
/**
|
|
854
|
+
* Secret access key.
|
|
855
|
+
*
|
|
856
|
+
* Required (along with `access_key_id`) if `role_arn` is None
|
|
857
|
+
*/
|
|
858
|
+
secretAccessKey?: string | null;
|
|
859
|
+
endpointUrl?: string | null;
|
|
860
|
+
/** Role ARN for delegated authentication */
|
|
861
|
+
roleArn?: string | null;
|
|
862
|
+
/**
|
|
863
|
+
* Shared secret passed as the STS ExternalId.
|
|
864
|
+
*
|
|
865
|
+
* Can only be set if `role_arn` is Some
|
|
866
|
+
*/
|
|
867
|
+
externalId?: string | null;
|
|
868
|
+
}
|
|
869
|
+
//#endregion
|
|
870
|
+
//#region src/models/sqsConfigIn.d.ts
|
|
871
|
+
/** Configuration for an SQS sink. */
|
|
872
|
+
interface SqsConfigIn {
|
|
873
|
+
queueUrl: string;
|
|
874
|
+
/**
|
|
875
|
+
* The region of the SQS queue.
|
|
876
|
+
*
|
|
877
|
+
* Currently a required field, but marked as optional because we may infer it from other fields in the future.
|
|
878
|
+
*/
|
|
879
|
+
region?: string | null;
|
|
880
|
+
/**
|
|
881
|
+
* Access key ID.
|
|
882
|
+
*
|
|
883
|
+
* Required (along with `secret_access_key`) if `role_arn` is blank.
|
|
884
|
+
*/
|
|
885
|
+
accessKeyId?: string | null;
|
|
886
|
+
/**
|
|
887
|
+
* Secret access key.
|
|
888
|
+
*
|
|
889
|
+
* Required (along with `access_key_id`) if `role_arn` is blank.
|
|
890
|
+
*/
|
|
891
|
+
secretAccessKey?: string | null;
|
|
892
|
+
/** Role ARN for delegated authentication */
|
|
893
|
+
roleArn?: string | null;
|
|
894
|
+
/**
|
|
895
|
+
* Shared secret passed as the STS ExternalId.
|
|
896
|
+
*
|
|
897
|
+
* Can only be set if `role_arn` is Some
|
|
898
|
+
*/
|
|
899
|
+
externalId?: string | null;
|
|
900
|
+
endpointUrl?: string | null;
|
|
901
|
+
}
|
|
902
|
+
//#endregion
|
|
903
|
+
//#region src/models/destinationIn.d.ts
|
|
904
|
+
interface _DestinationInFields {
|
|
905
|
+
/** An optional unique identifier for the destination. */
|
|
906
|
+
uid?: string | null;
|
|
907
|
+
/**
|
|
908
|
+
* Whether the destination will receive events.
|
|
909
|
+
*
|
|
910
|
+
* If the destination is `enabled`, events sent to the application will be dispatched to the destination in order.
|
|
911
|
+
*
|
|
912
|
+
* If the destination is `disabled`, events will not be dispatched until the destination is reenabled.
|
|
913
|
+
*/
|
|
914
|
+
status?: DestinationStatusIn;
|
|
915
|
+
/** How many events will be batched in a request to the destination. */
|
|
916
|
+
batchSize?: number;
|
|
917
|
+
/**
|
|
918
|
+
* How long to wait before a batch of events is sent, if the `batchSize` is not reached.
|
|
919
|
+
*
|
|
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.
|
|
921
|
+
*
|
|
922
|
+
* Note that an empty batch is never sent to the destination.
|
|
923
|
+
*/
|
|
924
|
+
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. */
|
|
926
|
+
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. */
|
|
928
|
+
channels?: string[];
|
|
929
|
+
metadata?: {
|
|
930
|
+
[key: string]: string;
|
|
931
|
+
};
|
|
932
|
+
}
|
|
933
|
+
interface DestinationInPollingEndpointConfig {}
|
|
934
|
+
interface DestinationInPollingEndpoint {
|
|
935
|
+
type: "pollingEndpoint";
|
|
936
|
+
config?: DestinationInPollingEndpointConfig;
|
|
937
|
+
}
|
|
938
|
+
interface DestinationInAzureBlobStorage {
|
|
939
|
+
type: "azureBlobStorage";
|
|
940
|
+
config: AzureBlobStorageConfigIn;
|
|
941
|
+
}
|
|
942
|
+
interface DestinationInOtelTracing {
|
|
943
|
+
type: "otelTracing";
|
|
944
|
+
config: OtelTracingConfigIn;
|
|
945
|
+
}
|
|
946
|
+
interface DestinationInFifoEndpoint {
|
|
947
|
+
type: "fifoEndpoint";
|
|
948
|
+
config: FifoEndpointConfigIn;
|
|
949
|
+
}
|
|
950
|
+
interface DestinationInAmazonS3 {
|
|
951
|
+
type: "amazonS3";
|
|
952
|
+
config: S3ConfigIn;
|
|
953
|
+
}
|
|
954
|
+
interface DestinationInGoogleCloudStorage {
|
|
955
|
+
type: "googleCloudStorage";
|
|
956
|
+
config: GoogleCloudStorageConfigIn;
|
|
957
|
+
}
|
|
958
|
+
interface DestinationInGoogleCloudPubSub {
|
|
959
|
+
type: "googleCloudPubSub";
|
|
960
|
+
config: GoogleCloudPubSubConfigIn;
|
|
961
|
+
}
|
|
962
|
+
interface DestinationInSqs {
|
|
963
|
+
type: "sqs";
|
|
964
|
+
config: SqsConfigIn;
|
|
965
|
+
}
|
|
966
|
+
interface DestinationInSns {
|
|
967
|
+
type: "sns";
|
|
968
|
+
config: SnsConfigIn;
|
|
969
|
+
}
|
|
970
|
+
interface DestinationInBigQuery {
|
|
971
|
+
type: "bigQuery";
|
|
972
|
+
config: BigQueryConfigIn;
|
|
973
|
+
}
|
|
974
|
+
interface DestinationInClickhouse {
|
|
975
|
+
type: "clickhouse";
|
|
976
|
+
config: ClickhouseConfigIn;
|
|
977
|
+
}
|
|
978
|
+
interface DestinationInEventBridge {
|
|
979
|
+
type: "eventBridge";
|
|
980
|
+
config: EventBridgeConfigIn;
|
|
981
|
+
}
|
|
982
|
+
interface DestinationInSnowflake {
|
|
983
|
+
type: "snowflake";
|
|
984
|
+
config: SnowflakeConfigIn;
|
|
985
|
+
}
|
|
986
|
+
interface DestinationInRabbitMq {
|
|
987
|
+
type: "rabbitMq";
|
|
988
|
+
config: RabbitMqConfigIn;
|
|
989
|
+
}
|
|
990
|
+
interface DestinationInRedshift {
|
|
991
|
+
type: "redshift";
|
|
992
|
+
config: RedshiftConfigIn;
|
|
993
|
+
}
|
|
994
|
+
interface DestinationInPostgres {
|
|
995
|
+
type: "postgres";
|
|
996
|
+
config: PostgresConfigIn;
|
|
997
|
+
}
|
|
998
|
+
/** The destination's type and type-specific configuration. */
|
|
999
|
+
type DestinationIn = _DestinationInFields & (DestinationInPollingEndpoint | DestinationInAzureBlobStorage | DestinationInOtelTracing | DestinationInFifoEndpoint | DestinationInAmazonS3 | DestinationInGoogleCloudStorage | DestinationInGoogleCloudPubSub | DestinationInSqs | DestinationInSns | DestinationInBigQuery | DestinationInClickhouse | DestinationInEventBridge | DestinationInSnowflake | DestinationInRabbitMq | DestinationInRedshift | DestinationInPostgres);
|
|
1000
|
+
//#endregion
|
|
1001
|
+
//#region src/models/azureBlobStorageConfigOut.d.ts
|
|
1002
|
+
interface AzureBlobStorageConfigOut {
|
|
1003
|
+
container: string;
|
|
1004
|
+
account: string;
|
|
1005
|
+
}
|
|
1006
|
+
//#endregion
|
|
1007
|
+
//#region src/models/bigQueryConfigOut.d.ts
|
|
1008
|
+
interface BigQueryConfigOut {
|
|
1009
|
+
projectId: string;
|
|
1010
|
+
datasetId: string;
|
|
1011
|
+
tableId: string;
|
|
1012
|
+
}
|
|
1013
|
+
//#endregion
|
|
1014
|
+
//#region src/models/clickhouseConfigOut.d.ts
|
|
1015
|
+
interface ClickhouseConfigOut {
|
|
1016
|
+
url: string;
|
|
1017
|
+
username: string;
|
|
1018
|
+
database: string;
|
|
1019
|
+
tableName: string;
|
|
1020
|
+
}
|
|
1021
|
+
//#endregion
|
|
1022
|
+
//#region src/models/destinationStatus.d.ts
|
|
1023
|
+
declare enum DestinationStatus {
|
|
1024
|
+
Enabled = "enabled",
|
|
1025
|
+
Paused = "paused",
|
|
1026
|
+
Disabled = "disabled",
|
|
1027
|
+
Retrying = "retrying"
|
|
1028
|
+
}
|
|
1029
|
+
//#endregion
|
|
1030
|
+
//#region src/models/eventBridgeConfigOut.d.ts
|
|
1031
|
+
interface EventBridgeConfigOut {
|
|
1032
|
+
eventBusName: string;
|
|
1033
|
+
detailType: string;
|
|
1034
|
+
accessKeyId?: string | null;
|
|
1035
|
+
roleArn?: string | null;
|
|
1036
|
+
externalId?: string | null;
|
|
1037
|
+
region: string;
|
|
1038
|
+
}
|
|
1039
|
+
//#endregion
|
|
1040
|
+
//#region src/models/googleCloudPubSubConfigOut.d.ts
|
|
1041
|
+
interface GoogleCloudPubSubConfigOut {
|
|
1042
|
+
projectId: string;
|
|
1043
|
+
topicId: string;
|
|
1044
|
+
}
|
|
1045
|
+
//#endregion
|
|
1046
|
+
//#region src/models/googleCloudStorageConfigOut.d.ts
|
|
1047
|
+
interface GoogleCloudStorageConfigOut {
|
|
1048
|
+
bucket: string;
|
|
1049
|
+
}
|
|
1050
|
+
//#endregion
|
|
1051
|
+
//#region src/models/endpointHeadersOut.d.ts
|
|
1052
|
+
/**
|
|
1053
|
+
* The value of the headers is returned in the `headers` field.
|
|
1054
|
+
*
|
|
1055
|
+
* Sensitive headers that have been redacted are returned in the sensitive field.
|
|
1056
|
+
*/
|
|
1057
|
+
interface EndpointHeadersOut {
|
|
1058
|
+
headers: {
|
|
1059
|
+
[key: string]: string;
|
|
1060
|
+
};
|
|
1061
|
+
sensitive: string[];
|
|
1062
|
+
}
|
|
1063
|
+
//#endregion
|
|
1064
|
+
//#region src/models/otelTracingConfigOut.d.ts
|
|
1065
|
+
interface OtelTracingConfigOut {
|
|
1066
|
+
url: string;
|
|
1067
|
+
headers: EndpointHeadersOut;
|
|
1068
|
+
}
|
|
1069
|
+
//#endregion
|
|
1070
|
+
//#region src/models/postgresConfigOut.d.ts
|
|
1071
|
+
interface PostgresConfigOut {
|
|
1072
|
+
url: string;
|
|
1073
|
+
tableName: string;
|
|
1074
|
+
sslRootCert?: string | null;
|
|
1075
|
+
}
|
|
1076
|
+
//#endregion
|
|
1077
|
+
//#region src/models/rabbitMqConfigOut.d.ts
|
|
1078
|
+
interface RabbitMqConfigOut {
|
|
1079
|
+
routingKey: string;
|
|
1080
|
+
}
|
|
1081
|
+
//#endregion
|
|
1082
|
+
//#region src/models/redshiftConfigOut.d.ts
|
|
1083
|
+
interface RedshiftConfigOut {
|
|
1084
|
+
accessKeyId?: string | null;
|
|
1085
|
+
roleArn?: string | null;
|
|
1086
|
+
externalId?: string | null;
|
|
1087
|
+
region: string;
|
|
1088
|
+
clusterIdentifier?: string | null;
|
|
1089
|
+
dbUser?: string | null;
|
|
1090
|
+
workgroupName?: string | null;
|
|
1091
|
+
/**
|
|
1092
|
+
* Database name.
|
|
1093
|
+
*
|
|
1094
|
+
* Only required if not using transformations.
|
|
1095
|
+
*/
|
|
1096
|
+
dbName?: string;
|
|
1097
|
+
/**
|
|
1098
|
+
* Schema name.
|
|
1099
|
+
*
|
|
1100
|
+
* Only used if not using transformations.
|
|
1101
|
+
*/
|
|
1102
|
+
schemaName?: string | null;
|
|
1103
|
+
/**
|
|
1104
|
+
* Table name.
|
|
1105
|
+
*
|
|
1106
|
+
* Only required if not using transformations.
|
|
1107
|
+
*/
|
|
1108
|
+
tableName?: string;
|
|
1109
|
+
}
|
|
1110
|
+
//#endregion
|
|
1111
|
+
//#region src/models/s3ConfigOut.d.ts
|
|
1112
|
+
interface S3ConfigOut {
|
|
1113
|
+
bucket: string;
|
|
1114
|
+
accessKeyId?: string | null;
|
|
1115
|
+
region: string;
|
|
1116
|
+
endpointUrl?: string | null;
|
|
1117
|
+
roleArn?: string | null;
|
|
1118
|
+
externalId?: string | null;
|
|
1119
|
+
}
|
|
1120
|
+
//#endregion
|
|
1121
|
+
//#region src/models/sinkHttpConfigOut.d.ts
|
|
1122
|
+
interface SinkHttpConfigOut {
|
|
1123
|
+
url: string;
|
|
1124
|
+
headers: EndpointHeadersOut;
|
|
1125
|
+
}
|
|
1126
|
+
//#endregion
|
|
1127
|
+
//#region src/models/snowflakeConfigOut.d.ts
|
|
1128
|
+
interface SnowflakeConfigOut {
|
|
1129
|
+
accountIdentifier: string;
|
|
1130
|
+
userId: string;
|
|
1131
|
+
/**
|
|
1132
|
+
* Database name.
|
|
1133
|
+
*
|
|
1134
|
+
* Only required if not using transformations.
|
|
1135
|
+
*/
|
|
1136
|
+
dbName?: string;
|
|
1137
|
+
/**
|
|
1138
|
+
* Schema name.
|
|
1139
|
+
*
|
|
1140
|
+
* Only required if not using transformations.
|
|
1141
|
+
*/
|
|
1142
|
+
schemaName?: string;
|
|
1143
|
+
/**
|
|
1144
|
+
* Table name.
|
|
1145
|
+
*
|
|
1146
|
+
* Only required if not using transformations.
|
|
1147
|
+
*/
|
|
1148
|
+
tableName?: string;
|
|
1149
|
+
}
|
|
1150
|
+
//#endregion
|
|
1151
|
+
//#region src/models/snsConfigOut.d.ts
|
|
1152
|
+
interface SnsConfigOut {
|
|
1153
|
+
topicArn: string;
|
|
1154
|
+
region: string;
|
|
1155
|
+
accessKeyId?: string | null;
|
|
1156
|
+
roleArn?: string | null;
|
|
1157
|
+
externalId?: string | null;
|
|
1158
|
+
}
|
|
1159
|
+
//#endregion
|
|
1160
|
+
//#region src/models/sqsConfigOut.d.ts
|
|
1161
|
+
interface SqsConfigOut {
|
|
1162
|
+
queueUrl: string;
|
|
1163
|
+
region: string;
|
|
1164
|
+
accessKeyId?: string | null;
|
|
1165
|
+
roleArn?: string | null;
|
|
1166
|
+
externalId?: string | null;
|
|
1167
|
+
endpointUrl?: string | null;
|
|
1168
|
+
}
|
|
1169
|
+
//#endregion
|
|
1170
|
+
//#region src/models/destinationOut.d.ts
|
|
1171
|
+
interface _DestinationOutFields {
|
|
1172
|
+
/** The Destination's ID. */
|
|
1173
|
+
id: string;
|
|
1174
|
+
/** The Destination's UID. */
|
|
1175
|
+
uid?: string | null;
|
|
1176
|
+
status: DestinationStatus;
|
|
1177
|
+
currentIterator: string;
|
|
1178
|
+
failureReason?: string | null;
|
|
1179
|
+
createdAt: Date;
|
|
1180
|
+
updatedAt: Date;
|
|
1181
|
+
batchSize: number;
|
|
1182
|
+
maxWaitSecs: number;
|
|
1183
|
+
eventTypes?: string[];
|
|
1184
|
+
channels?: string[];
|
|
1185
|
+
nextRetryAt?: Date | null;
|
|
1186
|
+
metadata: {
|
|
1187
|
+
[key: string]: string;
|
|
1188
|
+
};
|
|
1189
|
+
}
|
|
1190
|
+
interface DestinationOutPollingEndpointConfig {}
|
|
1191
|
+
interface DestinationOutPollingEndpoint {
|
|
1192
|
+
type: "pollingEndpoint";
|
|
1193
|
+
config?: DestinationOutPollingEndpointConfig;
|
|
1194
|
+
}
|
|
1195
|
+
interface DestinationOutAzureBlobStorage {
|
|
1196
|
+
type: "azureBlobStorage";
|
|
1197
|
+
config: AzureBlobStorageConfigOut;
|
|
1198
|
+
}
|
|
1199
|
+
interface DestinationOutOtelTracing {
|
|
1200
|
+
type: "otelTracing";
|
|
1201
|
+
config: OtelTracingConfigOut;
|
|
1202
|
+
}
|
|
1203
|
+
interface DestinationOutFifoEndpoint {
|
|
1204
|
+
type: "fifoEndpoint";
|
|
1205
|
+
config: SinkHttpConfigOut;
|
|
1206
|
+
}
|
|
1207
|
+
interface DestinationOutAmazonS3 {
|
|
1208
|
+
type: "amazonS3";
|
|
1209
|
+
config: S3ConfigOut;
|
|
1210
|
+
}
|
|
1211
|
+
interface DestinationOutSnowflake {
|
|
1212
|
+
type: "snowflake";
|
|
1213
|
+
config: SnowflakeConfigOut;
|
|
1214
|
+
}
|
|
1215
|
+
interface DestinationOutGoogleCloudStorage {
|
|
1216
|
+
type: "googleCloudStorage";
|
|
1217
|
+
config: GoogleCloudStorageConfigOut;
|
|
1218
|
+
}
|
|
1219
|
+
interface DestinationOutGoogleCloudPubSub {
|
|
1220
|
+
type: "googleCloudPubSub";
|
|
1221
|
+
config: GoogleCloudPubSubConfigOut;
|
|
1222
|
+
}
|
|
1223
|
+
interface DestinationOutRedshift {
|
|
1224
|
+
type: "redshift";
|
|
1225
|
+
config: RedshiftConfigOut;
|
|
1226
|
+
}
|
|
1227
|
+
interface DestinationOutBigQuery {
|
|
1228
|
+
type: "bigQuery";
|
|
1229
|
+
config: BigQueryConfigOut;
|
|
1230
|
+
}
|
|
1231
|
+
interface DestinationOutClickhouse {
|
|
1232
|
+
type: "clickhouse";
|
|
1233
|
+
config: ClickhouseConfigOut;
|
|
1234
|
+
}
|
|
1235
|
+
interface DestinationOutRabbitMq {
|
|
1236
|
+
type: "rabbitMq";
|
|
1237
|
+
config: RabbitMqConfigOut;
|
|
1238
|
+
}
|
|
1239
|
+
interface DestinationOutSqs {
|
|
1240
|
+
type: "sqs";
|
|
1241
|
+
config: SqsConfigOut;
|
|
1242
|
+
}
|
|
1243
|
+
interface DestinationOutEventBridge {
|
|
1244
|
+
type: "eventBridge";
|
|
1245
|
+
config: EventBridgeConfigOut;
|
|
1246
|
+
}
|
|
1247
|
+
interface DestinationOutSns {
|
|
1248
|
+
type: "sns";
|
|
1249
|
+
config: SnsConfigOut;
|
|
1250
|
+
}
|
|
1251
|
+
interface DestinationOutPostgres {
|
|
1252
|
+
type: "postgres";
|
|
1253
|
+
config: PostgresConfigOut;
|
|
1254
|
+
}
|
|
1255
|
+
type DestinationOut = _DestinationOutFields & (DestinationOutPollingEndpoint | DestinationOutAzureBlobStorage | DestinationOutOtelTracing | DestinationOutFifoEndpoint | DestinationOutAmazonS3 | DestinationOutSnowflake | DestinationOutGoogleCloudStorage | DestinationOutGoogleCloudPubSub | DestinationOutRedshift | DestinationOutBigQuery | DestinationOutClickhouse | DestinationOutRabbitMq | DestinationOutSqs | DestinationOutEventBridge | DestinationOutSns | DestinationOutPostgres);
|
|
1256
|
+
//#endregion
|
|
1257
|
+
//#region src/models/azureBlobStorageConfigPatch.d.ts
|
|
1258
|
+
interface AzureBlobStorageConfigPatch {
|
|
1259
|
+
container?: string;
|
|
1260
|
+
account?: string;
|
|
1261
|
+
accessKey?: string;
|
|
1262
|
+
}
|
|
1263
|
+
//#endregion
|
|
1264
|
+
//#region src/models/bigQueryConfigPatch.d.ts
|
|
1265
|
+
interface BigQueryConfigPatch {
|
|
1266
|
+
projectId?: string;
|
|
1267
|
+
datasetId?: string;
|
|
1268
|
+
tableId?: string;
|
|
1269
|
+
credentials?: string;
|
|
1270
|
+
}
|
|
1271
|
+
//#endregion
|
|
1272
|
+
//#region src/models/clickhouseConfigPatch.d.ts
|
|
1273
|
+
interface ClickhouseConfigPatch {
|
|
1274
|
+
url?: string;
|
|
1275
|
+
username?: string;
|
|
1276
|
+
password?: string;
|
|
1277
|
+
database?: string;
|
|
1278
|
+
tableName?: string;
|
|
1279
|
+
}
|
|
1280
|
+
//#endregion
|
|
1281
|
+
//#region src/models/eventBridgeConfigPatch.d.ts
|
|
1282
|
+
interface EventBridgeConfigPatch {
|
|
1283
|
+
eventBusName?: string;
|
|
1284
|
+
detailType?: string;
|
|
1285
|
+
accessKeyId?: string;
|
|
1286
|
+
secretAccessKey?: string;
|
|
1287
|
+
roleArn?: string;
|
|
1288
|
+
externalId?: string;
|
|
1289
|
+
region?: string;
|
|
1290
|
+
}
|
|
1291
|
+
//#endregion
|
|
1292
|
+
//#region src/models/googleCloudPubSubConfigPatch.d.ts
|
|
1293
|
+
interface GoogleCloudPubSubConfigPatch {
|
|
1294
|
+
projectId?: string;
|
|
1295
|
+
topicId?: string;
|
|
1296
|
+
credentials?: string;
|
|
1297
|
+
}
|
|
1298
|
+
//#endregion
|
|
1299
|
+
//#region src/models/googleCloudStorageConfigPatch.d.ts
|
|
1300
|
+
interface GoogleCloudStorageConfigPatch {
|
|
1301
|
+
bucket?: string;
|
|
1302
|
+
credentials?: string;
|
|
1303
|
+
}
|
|
1304
|
+
//#endregion
|
|
1305
|
+
//#region src/models/otelTracingConfigPatch.d.ts
|
|
1306
|
+
interface OtelTracingConfigPatch {
|
|
1307
|
+
url?: string;
|
|
1308
|
+
}
|
|
1309
|
+
//#endregion
|
|
1310
|
+
//#region src/models/postgresConfigPatch.d.ts
|
|
1311
|
+
interface PostgresConfigPatch {
|
|
1312
|
+
url?: string;
|
|
1313
|
+
password?: string;
|
|
1314
|
+
tableName?: string;
|
|
1315
|
+
sslRootCert?: string;
|
|
1316
|
+
}
|
|
1317
|
+
//#endregion
|
|
1318
|
+
//#region src/models/rabbitMqConfigPatch.d.ts
|
|
1319
|
+
interface RabbitMqConfigPatch {
|
|
1320
|
+
routingKey?: string;
|
|
1321
|
+
uri?: string;
|
|
1322
|
+
}
|
|
1323
|
+
//#endregion
|
|
1324
|
+
//#region src/models/redshiftConfigPatch.d.ts
|
|
1325
|
+
interface RedshiftConfigPatch {
|
|
1326
|
+
accessKeyId?: string;
|
|
1327
|
+
secretAccessKey?: string;
|
|
1328
|
+
roleArn?: string;
|
|
1329
|
+
externalId?: string;
|
|
1330
|
+
region?: string;
|
|
1331
|
+
/**
|
|
1332
|
+
* Database name.
|
|
1333
|
+
*
|
|
1334
|
+
* Only required if not using transformations.
|
|
1335
|
+
*/
|
|
1336
|
+
dbName?: string;
|
|
1337
|
+
/**
|
|
1338
|
+
* Schema name.
|
|
1339
|
+
*
|
|
1340
|
+
* Only used if not using transformations.
|
|
1341
|
+
*/
|
|
1342
|
+
schemaName?: string | null;
|
|
1343
|
+
/**
|
|
1344
|
+
* Table name.
|
|
1345
|
+
*
|
|
1346
|
+
* Only required if not using transformations.
|
|
1347
|
+
*/
|
|
1348
|
+
tableName?: string;
|
|
1349
|
+
}
|
|
1350
|
+
//#endregion
|
|
1351
|
+
//#region src/models/s3ConfigPatch.d.ts
|
|
1352
|
+
interface S3ConfigPatch {
|
|
1353
|
+
bucket?: string;
|
|
1354
|
+
accessKeyId?: string;
|
|
1355
|
+
secretAccessKey?: string;
|
|
1356
|
+
roleArn?: string;
|
|
1357
|
+
externalId?: string;
|
|
1358
|
+
region?: string;
|
|
1359
|
+
endpointUrl?: string;
|
|
1360
|
+
}
|
|
1361
|
+
//#endregion
|
|
1362
|
+
//#region src/models/sinkHttpConfigPatch.d.ts
|
|
1363
|
+
interface SinkHttpConfigPatch {
|
|
1364
|
+
url?: string;
|
|
1365
|
+
}
|
|
1366
|
+
//#endregion
|
|
1367
|
+
//#region src/models/snowflakeConfigPatch.d.ts
|
|
1368
|
+
interface SnowflakeConfigPatch {
|
|
1369
|
+
privateKey?: string;
|
|
1370
|
+
accountIdentifier?: string;
|
|
1371
|
+
userId?: string;
|
|
1372
|
+
/**
|
|
1373
|
+
* Database name.
|
|
1374
|
+
*
|
|
1375
|
+
* Only required if not using transformations.
|
|
1376
|
+
*/
|
|
1377
|
+
dbName?: string;
|
|
1378
|
+
/**
|
|
1379
|
+
* Schema name.
|
|
1380
|
+
*
|
|
1381
|
+
* Only required if not using transformations.
|
|
1382
|
+
*/
|
|
1383
|
+
schemaName?: string;
|
|
1384
|
+
/**
|
|
1385
|
+
* Table name.
|
|
1386
|
+
*
|
|
1387
|
+
* Only required if not using transformations.
|
|
1388
|
+
*/
|
|
1389
|
+
tableName?: string;
|
|
1390
|
+
}
|
|
1391
|
+
//#endregion
|
|
1392
|
+
//#region src/models/snsConfigPatch.d.ts
|
|
1393
|
+
interface SnsConfigPatch {
|
|
1394
|
+
topicArn?: string;
|
|
1395
|
+
region?: string;
|
|
1396
|
+
accessKeyId?: string;
|
|
1397
|
+
secretAccessKey?: string;
|
|
1398
|
+
roleArn?: string;
|
|
1399
|
+
externalId?: string;
|
|
1400
|
+
endpointUrl?: string | null;
|
|
1401
|
+
}
|
|
1402
|
+
//#endregion
|
|
1403
|
+
//#region src/models/sqsConfigPatch.d.ts
|
|
1404
|
+
interface SqsConfigPatch {
|
|
1405
|
+
queueUrl?: string;
|
|
1406
|
+
region?: string;
|
|
1407
|
+
accessKeyId?: string;
|
|
1408
|
+
secretAccessKey?: string;
|
|
1409
|
+
roleArn?: string;
|
|
1410
|
+
externalId?: string;
|
|
1411
|
+
endpointUrl?: string | null;
|
|
1412
|
+
}
|
|
1413
|
+
//#endregion
|
|
1414
|
+
//#region src/models/destinationPatch.d.ts
|
|
1415
|
+
interface _DestinationPatchFields {
|
|
1416
|
+
/** The Destination's UID. */
|
|
1417
|
+
uid?: string | null;
|
|
1418
|
+
status?: DestinationStatusIn | null;
|
|
1419
|
+
batchSize?: number | null;
|
|
1420
|
+
maxWaitSecs?: number | null;
|
|
1421
|
+
eventTypes?: string[];
|
|
1422
|
+
channels?: string[];
|
|
1423
|
+
metadata?: {
|
|
1424
|
+
[key: string]: string;
|
|
1425
|
+
};
|
|
1426
|
+
}
|
|
1427
|
+
interface DestinationPatchPollingEndpointConfig {}
|
|
1428
|
+
interface DestinationPatchPollingEndpoint {
|
|
1429
|
+
type: "pollingEndpoint";
|
|
1430
|
+
config?: DestinationPatchPollingEndpointConfig;
|
|
1431
|
+
}
|
|
1432
|
+
interface DestinationPatchAzureBlobStorage {
|
|
1433
|
+
type: "azureBlobStorage";
|
|
1434
|
+
config: AzureBlobStorageConfigPatch;
|
|
1435
|
+
}
|
|
1436
|
+
interface DestinationPatchOtelTracing {
|
|
1437
|
+
type: "otelTracing";
|
|
1438
|
+
config: OtelTracingConfigPatch;
|
|
1439
|
+
}
|
|
1440
|
+
interface DestinationPatchFifoEndpoint {
|
|
1441
|
+
type: "fifoEndpoint";
|
|
1442
|
+
config: SinkHttpConfigPatch;
|
|
1443
|
+
}
|
|
1444
|
+
interface DestinationPatchAmazonS3 {
|
|
1445
|
+
type: "amazonS3";
|
|
1446
|
+
config: S3ConfigPatch;
|
|
1447
|
+
}
|
|
1448
|
+
interface DestinationPatchGoogleCloudStorage {
|
|
1449
|
+
type: "googleCloudStorage";
|
|
1450
|
+
config: GoogleCloudStorageConfigPatch;
|
|
1451
|
+
}
|
|
1452
|
+
interface DestinationPatchGoogleCloudPubSub {
|
|
1453
|
+
type: "googleCloudPubSub";
|
|
1454
|
+
config: GoogleCloudPubSubConfigPatch;
|
|
1455
|
+
}
|
|
1456
|
+
interface DestinationPatchSqs {
|
|
1457
|
+
type: "sqs";
|
|
1458
|
+
config: SqsConfigPatch;
|
|
1459
|
+
}
|
|
1460
|
+
interface DestinationPatchSns {
|
|
1461
|
+
type: "sns";
|
|
1462
|
+
config: SnsConfigPatch;
|
|
1463
|
+
}
|
|
1464
|
+
interface DestinationPatchBigQuery {
|
|
1465
|
+
type: "bigQuery";
|
|
1466
|
+
config: BigQueryConfigPatch;
|
|
1467
|
+
}
|
|
1468
|
+
interface DestinationPatchClickhouse {
|
|
1469
|
+
type: "clickhouse";
|
|
1470
|
+
config: ClickhouseConfigPatch;
|
|
1471
|
+
}
|
|
1472
|
+
interface DestinationPatchEventBridge {
|
|
1473
|
+
type: "eventBridge";
|
|
1474
|
+
config: EventBridgeConfigPatch;
|
|
1475
|
+
}
|
|
1476
|
+
interface DestinationPatchSnowflake {
|
|
1477
|
+
type: "snowflake";
|
|
1478
|
+
config: SnowflakeConfigPatch;
|
|
1479
|
+
}
|
|
1480
|
+
interface DestinationPatchRabbitMq {
|
|
1481
|
+
type: "rabbitMq";
|
|
1482
|
+
config: RabbitMqConfigPatch;
|
|
1483
|
+
}
|
|
1484
|
+
interface DestinationPatchRedshift {
|
|
1485
|
+
type: "redshift";
|
|
1486
|
+
config: RedshiftConfigPatch;
|
|
1487
|
+
}
|
|
1488
|
+
interface DestinationPatchPostgres {
|
|
1489
|
+
type: "postgres";
|
|
1490
|
+
config: PostgresConfigPatch;
|
|
1491
|
+
}
|
|
1492
|
+
type DestinationPatch = _DestinationPatchFields & (DestinationPatchPollingEndpoint | DestinationPatchAzureBlobStorage | DestinationPatchOtelTracing | DestinationPatchFifoEndpoint | DestinationPatchAmazonS3 | DestinationPatchGoogleCloudStorage | DestinationPatchGoogleCloudPubSub | DestinationPatchSqs | DestinationPatchSns | DestinationPatchBigQuery | DestinationPatchClickhouse | DestinationPatchEventBridge | DestinationPatchSnowflake | DestinationPatchRabbitMq | DestinationPatchRedshift | DestinationPatchPostgres);
|
|
1493
|
+
//#endregion
|
|
1494
|
+
//#region src/models/listResponseDestinationOut.d.ts
|
|
1495
|
+
interface ListResponseDestinationOut {
|
|
1496
|
+
data: DestinationOut[];
|
|
1497
|
+
iterator: string | null;
|
|
1498
|
+
prevIterator?: string | null;
|
|
1499
|
+
done: boolean;
|
|
1500
|
+
}
|
|
1501
|
+
//#endregion
|
|
1502
|
+
//#region src/models/destinationTransformIn.d.ts
|
|
1503
|
+
interface DestinationTransformIn {
|
|
1504
|
+
code?: string | null;
|
|
1505
|
+
}
|
|
1506
|
+
//#endregion
|
|
1507
|
+
//#region src/models/destinationTransformationOut.d.ts
|
|
1508
|
+
interface DestinationTransformationOut {
|
|
1509
|
+
code?: string | null;
|
|
1510
|
+
enabled: boolean;
|
|
1511
|
+
}
|
|
1512
|
+
//#endregion
|
|
1513
|
+
//#region src/models/emptyResponse.d.ts
|
|
1514
|
+
interface EmptyResponse {}
|
|
1515
|
+
//#endregion
|
|
1516
|
+
//#region src/api/destinationTransformation.d.ts
|
|
1517
|
+
declare class DestinationTransformation {
|
|
1518
|
+
private readonly requestCtx;
|
|
1519
|
+
constructor(requestCtx: SvixRequestContext);
|
|
1520
|
+
/** Get the transformation code associated with this destination. */
|
|
1521
|
+
get(appId: string, destinationId: string): Promise<DestinationTransformationOut>;
|
|
1522
|
+
/** Set or unset the transformation code associated with this destination. */
|
|
1523
|
+
patch(appId: string, destinationId: string, destinationTransformIn?: DestinationTransformIn): Promise<EmptyResponse>;
|
|
1524
|
+
}
|
|
1525
|
+
//#endregion
|
|
1526
|
+
//#region src/api/destination.d.ts
|
|
1527
|
+
interface DestinationListOptions {
|
|
1528
|
+
/** Limit the number of returned items */
|
|
1529
|
+
limit?: number;
|
|
1530
|
+
/** The iterator returned from a prior invocation */
|
|
1531
|
+
iterator?: string | null;
|
|
1532
|
+
/** The sorting order of the returned items */
|
|
1533
|
+
order?: Ordering;
|
|
1534
|
+
}
|
|
1535
|
+
interface DestinationCreateOptions {
|
|
1536
|
+
idempotencyKey?: string;
|
|
1537
|
+
}
|
|
1538
|
+
declare class Destination {
|
|
1539
|
+
private readonly requestCtx;
|
|
1540
|
+
constructor(requestCtx: SvixRequestContext);
|
|
1541
|
+
get transformation(): DestinationTransformation;
|
|
1542
|
+
/** List of all the application's destinations. */
|
|
1543
|
+
list(appId: string, options?: DestinationListOptions): Promise<ListResponseDestinationOut>;
|
|
1544
|
+
/** Creates a new destination. */
|
|
1545
|
+
create(appId: string, destinationIn: DestinationIn, options?: DestinationCreateOptions): Promise<DestinationOut>;
|
|
1546
|
+
/** Get a destination by id or uid. */
|
|
1547
|
+
get(appId: string, destinationId: string): Promise<DestinationOut>;
|
|
1548
|
+
/** Create or update a destination. */
|
|
1549
|
+
upsert(appId: string, destinationId: string, destinationIn: DestinationIn): Promise<DestinationOut>;
|
|
1550
|
+
/** Delete a destination. */
|
|
1551
|
+
delete(appId: string, destinationId: string): Promise<void>;
|
|
1552
|
+
/** Partially update a destination. */
|
|
1553
|
+
patch(appId: string, destinationId: string, destinationPatch: DestinationPatch): Promise<DestinationOut>;
|
|
1554
|
+
}
|
|
1555
|
+
//#endregion
|
|
1556
|
+
//#region src/models/messageStatus.d.ts
|
|
1557
|
+
/**
|
|
1558
|
+
* The sending status of the message:
|
|
1559
|
+
*
|
|
1560
|
+
* - Success = 0
|
|
1561
|
+
* - Pending = 1
|
|
1562
|
+
* - Fail = 2
|
|
1563
|
+
* - Sending = 3
|
|
1564
|
+
* - Canceled = 4
|
|
1565
|
+
*/
|
|
1566
|
+
declare enum MessageStatus {
|
|
1567
|
+
Success = 0,
|
|
1568
|
+
Pending = 1,
|
|
1569
|
+
Fail = 2,
|
|
1570
|
+
Sending = 3,
|
|
1571
|
+
Canceled = 4
|
|
1572
|
+
}
|
|
1573
|
+
//#endregion
|
|
1574
|
+
//#region src/models/statusCodeClass.d.ts
|
|
1575
|
+
/**
|
|
1576
|
+
* The different classes of HTTP status codes:
|
|
1577
|
+
*
|
|
1578
|
+
* - CodeNone = 0
|
|
1579
|
+
* - Code1xx = 100
|
|
1580
|
+
* - Code2xx = 200
|
|
1581
|
+
* - Code3xx = 300
|
|
1582
|
+
* - Code4xx = 400
|
|
1583
|
+
* - Code5xx = 500
|
|
1584
|
+
*/
|
|
1585
|
+
declare enum StatusCodeClass {
|
|
1586
|
+
CodeNone = 0,
|
|
1587
|
+
Code1xx = 100,
|
|
1588
|
+
Code2xx = 200,
|
|
1589
|
+
Code3xx = 300,
|
|
1590
|
+
Code4xx = 400,
|
|
1591
|
+
Code5xx = 500
|
|
1592
|
+
}
|
|
1593
|
+
//#endregion
|
|
1594
|
+
//#region src/models/bulkReplayIn.d.ts
|
|
1595
|
+
interface BulkReplayIn {
|
|
1596
|
+
since: Date;
|
|
1597
|
+
until?: Date | null;
|
|
1598
|
+
eventTypes?: string[] | null;
|
|
1599
|
+
channel?: string | null;
|
|
1600
|
+
tag?: string | null;
|
|
1601
|
+
status?: MessageStatus | null;
|
|
1602
|
+
statusCodeClass?: StatusCodeClass | null;
|
|
1603
|
+
}
|
|
1604
|
+
//#endregion
|
|
1605
|
+
//#region src/models/endpointHeadersIn.d.ts
|
|
1606
|
+
interface EndpointHeadersIn {
|
|
1607
|
+
headers: {
|
|
1608
|
+
[key: string]: string;
|
|
1609
|
+
};
|
|
1610
|
+
}
|
|
1611
|
+
//#endregion
|
|
1612
|
+
//#region src/models/endpointHeadersPatchIn.d.ts
|
|
1613
|
+
interface EndpointHeadersPatchIn {
|
|
1614
|
+
headers: {
|
|
1615
|
+
[key: string]: string;
|
|
1616
|
+
};
|
|
1617
|
+
/** A list of headers be be removed */
|
|
1618
|
+
deleteHeaders?: string[];
|
|
1619
|
+
}
|
|
1620
|
+
//#endregion
|
|
1621
|
+
//#region src/models/endpointIn.d.ts
|
|
1622
|
+
interface EndpointIn {
|
|
1623
|
+
url: string;
|
|
1624
|
+
description?: string;
|
|
1625
|
+
/**
|
|
1626
|
+
* Maximum messages per second to send to this endpoint.
|
|
1627
|
+
*
|
|
1628
|
+
* Outgoing messages will be throttled to this rate.
|
|
1629
|
+
*/
|
|
1630
|
+
throttleRate?: number | null;
|
|
1631
|
+
/** Optional unique identifier for the endpoint. */
|
|
1632
|
+
uid?: string | null;
|
|
1633
|
+
disabled?: boolean;
|
|
1634
|
+
eventTypes?: string[] | null;
|
|
1635
|
+
/** List of message channels this endpoint listens to (omit for all). */
|
|
1636
|
+
channels?: string[] | null;
|
|
1637
|
+
/**
|
|
1638
|
+
* The endpoint's verification secret.
|
|
1639
|
+
*
|
|
1640
|
+
* Format: `base64` encoded random bytes optionally prefixed with `whsec_`.
|
|
1641
|
+
* It is recommended to not set this and let the server generate the secret.
|
|
1642
|
+
*/
|
|
1643
|
+
secret?: string | null;
|
|
1644
|
+
metadata?: {
|
|
1645
|
+
[key: string]: string;
|
|
1646
|
+
};
|
|
1647
|
+
headers?: {
|
|
1648
|
+
[key: string]: string;
|
|
1649
|
+
} | null;
|
|
1650
|
+
}
|
|
1651
|
+
//#endregion
|
|
1652
|
+
//#region src/models/endpointOut.d.ts
|
|
1653
|
+
interface EndpointOut {
|
|
1654
|
+
/** The Endpoint's ID. */
|
|
1655
|
+
id: string;
|
|
1656
|
+
metadata: {
|
|
1657
|
+
[key: string]: string;
|
|
1658
|
+
};
|
|
1659
|
+
url: string;
|
|
1660
|
+
description: string;
|
|
1661
|
+
/**
|
|
1662
|
+
* Maximum messages per second to send to this endpoint.
|
|
1663
|
+
*
|
|
1664
|
+
* Outgoing messages will be throttled to this rate.
|
|
1665
|
+
*/
|
|
1666
|
+
throttleRate?: number | null;
|
|
1667
|
+
/** Optional unique identifier for the endpoint. */
|
|
1668
|
+
uid?: string | null;
|
|
1669
|
+
disabled?: boolean;
|
|
1670
|
+
eventTypes?: string[] | null;
|
|
1671
|
+
/** List of message channels this endpoint listens to (omit for all). */
|
|
1672
|
+
channels?: string[] | null;
|
|
1673
|
+
createdAt: Date;
|
|
1674
|
+
updatedAt: Date;
|
|
1675
|
+
}
|
|
1676
|
+
//#endregion
|
|
1677
|
+
//#region src/models/endpointPatch.d.ts
|
|
1678
|
+
interface EndpointPatch {
|
|
1679
|
+
description?: string;
|
|
1680
|
+
/**
|
|
1681
|
+
* Maximum messages per second to send to this endpoint.
|
|
1682
|
+
*
|
|
1683
|
+
* Outgoing messages will be throttled to this rate.
|
|
1684
|
+
*/
|
|
1685
|
+
throttleRate?: number | null;
|
|
1686
|
+
/** The Endpoint's UID. */
|
|
1687
|
+
uid?: string | null;
|
|
1688
|
+
url?: string;
|
|
1689
|
+
disabled?: boolean;
|
|
1690
|
+
eventTypes?: string[] | null;
|
|
1691
|
+
channels?: string[] | null;
|
|
1692
|
+
metadata?: {
|
|
1693
|
+
[key: string]: string;
|
|
1694
|
+
};
|
|
1695
|
+
}
|
|
1696
|
+
//#endregion
|
|
1697
|
+
//#region src/models/endpointSecretOut.d.ts
|
|
1698
|
+
interface EndpointSecretOut {
|
|
1699
|
+
/**
|
|
1700
|
+
* The endpoint's verification secret.
|
|
1701
|
+
*
|
|
1702
|
+
* Format: `base64` encoded random bytes optionally prefixed with `whsec_`.
|
|
1703
|
+
* It is recommended to not set this and let the server generate the secret.
|
|
1704
|
+
*/
|
|
1705
|
+
key: string;
|
|
1706
|
+
}
|
|
1707
|
+
//#endregion
|
|
1708
|
+
//#region src/models/endpointStats.d.ts
|
|
1709
|
+
interface EndpointStats {
|
|
1710
|
+
success: number;
|
|
1711
|
+
pending: number;
|
|
1712
|
+
sending: number;
|
|
1713
|
+
fail: number;
|
|
1714
|
+
canceled: number;
|
|
1715
|
+
}
|
|
1716
|
+
//#endregion
|
|
1717
|
+
//#region src/models/endpointTransformationIn.d.ts
|
|
1718
|
+
interface EndpointTransformationIn {
|
|
1719
|
+
code?: string | null;
|
|
1720
|
+
enabled?: boolean;
|
|
1721
|
+
}
|
|
1722
|
+
//#endregion
|
|
1723
|
+
//#region src/models/endpointUpsertIn.d.ts
|
|
1724
|
+
interface EndpointUpsertIn {
|
|
1725
|
+
url: string;
|
|
713
1726
|
description?: string;
|
|
714
1727
|
/**
|
|
715
1728
|
* Maximum messages per second to send to this endpoint.
|
|
@@ -1443,6 +2456,11 @@ interface HubspotConfig {
|
|
|
1443
2456
|
secret?: string | null;
|
|
1444
2457
|
}
|
|
1445
2458
|
//#endregion
|
|
2459
|
+
//#region src/models/mergeConfig.d.ts
|
|
2460
|
+
interface MergeConfig {
|
|
2461
|
+
secret: string;
|
|
2462
|
+
}
|
|
2463
|
+
//#endregion
|
|
1446
2464
|
//#region src/models/metaConfig.d.ts
|
|
1447
2465
|
interface MetaConfig {
|
|
1448
2466
|
secret: string;
|
|
@@ -1607,6 +2625,10 @@ interface IngestSourceInLithic {
|
|
|
1607
2625
|
type: "lithic";
|
|
1608
2626
|
config: SvixConfig;
|
|
1609
2627
|
}
|
|
2628
|
+
interface IngestSourceInMerge {
|
|
2629
|
+
type: "merge";
|
|
2630
|
+
config: MergeConfig;
|
|
2631
|
+
}
|
|
1610
2632
|
interface IngestSourceInMeta {
|
|
1611
2633
|
type: "meta";
|
|
1612
2634
|
config: MetaConfig;
|
|
@@ -1723,7 +2745,7 @@ interface IngestSourceInVgs {
|
|
|
1723
2745
|
type: "vgs";
|
|
1724
2746
|
config: VgsConfig;
|
|
1725
2747
|
}
|
|
1726
|
-
type IngestSourceIn = _IngestSourceInFields & (IngestSourceInGenericWebhook | IngestSourceInCron | IngestSourceInAdobeSign | IngestSourceInBeehiiv | IngestSourceInBrex | IngestSourceInCheckbook | IngestSourceInClerk | IngestSourceInDocusign | IngestSourceInEasypost | IngestSourceInGithub | IngestSourceInGuesty | IngestSourceInHubspot | IngestSourceInIncidentIo | IngestSourceInLithic | IngestSourceInMeta | IngestSourceInNango | IngestSourceInNash | IngestSourceInOpenclaw | IngestSourceInOrumIo | IngestSourceInPandaDoc | IngestSourceInPortIo | IngestSourceInPleo | IngestSourceInPsiFi | IngestSourceInReplicate | IngestSourceInResend | IngestSourceInRutter | IngestSourceInSafebase | IngestSourceInSardine | IngestSourceInSegment | IngestSourceInShopify | IngestSourceInSlack | IngestSourceInStripe | IngestSourceInStych | IngestSourceInSvix | IngestSourceInZoom | IngestSourceInTailscale | IngestSourceInTelnyx | IngestSourceInVapi | IngestSourceInOpenAi | IngestSourceInRender | IngestSourceInVeriff | IngestSourceInAirwallex | IngestSourceInVgs);
|
|
2748
|
+
type IngestSourceIn = _IngestSourceInFields & (IngestSourceInGenericWebhook | IngestSourceInCron | IngestSourceInAdobeSign | IngestSourceInBeehiiv | IngestSourceInBrex | IngestSourceInCheckbook | IngestSourceInClerk | IngestSourceInDocusign | IngestSourceInEasypost | IngestSourceInGithub | IngestSourceInGuesty | IngestSourceInHubspot | IngestSourceInIncidentIo | IngestSourceInLithic | IngestSourceInMerge | IngestSourceInMeta | IngestSourceInNango | IngestSourceInNash | IngestSourceInOpenclaw | IngestSourceInOrumIo | IngestSourceInPandaDoc | IngestSourceInPortIo | IngestSourceInPleo | IngestSourceInPsiFi | IngestSourceInReplicate | IngestSourceInResend | IngestSourceInRutter | IngestSourceInSafebase | IngestSourceInSardine | IngestSourceInSegment | IngestSourceInShopify | IngestSourceInSlack | IngestSourceInStripe | IngestSourceInStych | IngestSourceInSvix | IngestSourceInZoom | IngestSourceInTailscale | IngestSourceInTelnyx | IngestSourceInVapi | IngestSourceInOpenAi | IngestSourceInRender | IngestSourceInVeriff | IngestSourceInAirwallex | IngestSourceInVgs);
|
|
1727
2749
|
//#endregion
|
|
1728
2750
|
//#region src/models/adobeSignConfigOut.d.ts
|
|
1729
2751
|
interface AdobeSignConfigOut {}
|
|
@@ -1746,6 +2768,9 @@ interface GithubConfigOut {}
|
|
|
1746
2768
|
//#region src/models/hubspotConfigOut.d.ts
|
|
1747
2769
|
interface HubspotConfigOut {}
|
|
1748
2770
|
//#endregion
|
|
2771
|
+
//#region src/models/mergeConfigOut.d.ts
|
|
2772
|
+
interface MergeConfigOut {}
|
|
2773
|
+
//#endregion
|
|
1749
2774
|
//#region src/models/metaConfigOut.d.ts
|
|
1750
2775
|
interface MetaConfigOut {}
|
|
1751
2776
|
//#endregion
|
|
@@ -1875,6 +2900,10 @@ interface IngestSourceOutLithic {
|
|
|
1875
2900
|
type: "lithic";
|
|
1876
2901
|
config: SvixConfigOut;
|
|
1877
2902
|
}
|
|
2903
|
+
interface IngestSourceOutMerge {
|
|
2904
|
+
type: "merge";
|
|
2905
|
+
config: MergeConfigOut;
|
|
2906
|
+
}
|
|
1878
2907
|
interface IngestSourceOutMeta {
|
|
1879
2908
|
type: "meta";
|
|
1880
2909
|
config: MetaConfigOut;
|
|
@@ -1991,7 +3020,7 @@ interface IngestSourceOutVgs {
|
|
|
1991
3020
|
type: "vgs";
|
|
1992
3021
|
config: VgsConfigOut;
|
|
1993
3022
|
}
|
|
1994
|
-
type IngestSourceOut = _IngestSourceOutFields & (IngestSourceOutGenericWebhook | IngestSourceOutCron | IngestSourceOutAdobeSign | IngestSourceOutBeehiiv | IngestSourceOutBrex | IngestSourceOutCheckbook | IngestSourceOutClerk | IngestSourceOutDocusign | IngestSourceOutEasypost | IngestSourceOutGithub | IngestSourceOutGuesty | IngestSourceOutHubspot | IngestSourceOutIncidentIo | IngestSourceOutLithic | IngestSourceOutMeta | IngestSourceOutNango | IngestSourceOutNash | IngestSourceOutOpenclaw | IngestSourceOutOrumIo | IngestSourceOutPandaDoc | IngestSourceOutPortIo | IngestSourceOutPsiFi | IngestSourceOutPleo | IngestSourceOutReplicate | IngestSourceOutResend | IngestSourceOutRutter | IngestSourceOutSafebase | IngestSourceOutSardine | IngestSourceOutSegment | IngestSourceOutShopify | IngestSourceOutSlack | IngestSourceOutStripe | IngestSourceOutStych | IngestSourceOutSvix | IngestSourceOutZoom | IngestSourceOutTailscale | IngestSourceOutTelnyx | IngestSourceOutVapi | IngestSourceOutOpenAi | IngestSourceOutRender | IngestSourceOutVeriff | IngestSourceOutAirwallex | IngestSourceOutVgs);
|
|
3023
|
+
type IngestSourceOut = _IngestSourceOutFields & (IngestSourceOutGenericWebhook | IngestSourceOutCron | IngestSourceOutAdobeSign | IngestSourceOutBeehiiv | IngestSourceOutBrex | IngestSourceOutCheckbook | IngestSourceOutClerk | IngestSourceOutDocusign | IngestSourceOutEasypost | IngestSourceOutGithub | IngestSourceOutGuesty | IngestSourceOutHubspot | IngestSourceOutIncidentIo | IngestSourceOutLithic | IngestSourceOutMerge | IngestSourceOutMeta | IngestSourceOutNango | IngestSourceOutNash | IngestSourceOutOpenclaw | IngestSourceOutOrumIo | IngestSourceOutPandaDoc | IngestSourceOutPortIo | IngestSourceOutPsiFi | IngestSourceOutPleo | IngestSourceOutReplicate | IngestSourceOutResend | IngestSourceOutRutter | IngestSourceOutSafebase | IngestSourceOutSardine | IngestSourceOutSegment | IngestSourceOutShopify | IngestSourceOutSlack | IngestSourceOutStripe | IngestSourceOutStych | IngestSourceOutSvix | IngestSourceOutZoom | IngestSourceOutTailscale | IngestSourceOutTelnyx | IngestSourceOutVapi | IngestSourceOutOpenAi | IngestSourceOutRender | IngestSourceOutVeriff | IngestSourceOutAirwallex | IngestSourceOutVgs);
|
|
1995
3024
|
//#endregion
|
|
1996
3025
|
//#region src/models/listResponseIngestSourceOut.d.ts
|
|
1997
3026
|
interface ListResponseIngestSourceOut {
|
|
@@ -2421,9 +3450,6 @@ declare class Message {
|
|
|
2421
3450
|
*/
|
|
2422
3451
|
declare function messageInRaw(eventType: string, payload: string, contentType?: string): MessageIn;
|
|
2423
3452
|
//#endregion
|
|
2424
|
-
//#region src/models/emptyResponse.d.ts
|
|
2425
|
-
interface EmptyResponse {}
|
|
2426
|
-
//#endregion
|
|
2427
3453
|
//#region src/models/messageStatusText.d.ts
|
|
2428
3454
|
declare enum MessageStatusText {
|
|
2429
3455
|
Success = "success",
|
|
@@ -3115,166 +4141,26 @@ interface StreamingEventsGetOptions {
|
|
|
3115
4141
|
}
|
|
3116
4142
|
interface StreamingEventsCreateOptions {
|
|
3117
4143
|
idempotencyKey?: string;
|
|
3118
|
-
}
|
|
3119
|
-
declare class StreamingEvents {
|
|
3120
|
-
private readonly requestCtx;
|
|
3121
|
-
constructor(requestCtx: SvixRequestContext);
|
|
3122
|
-
/**
|
|
3123
|
-
* Iterate over a stream of events.
|
|
3124
|
-
*
|
|
3125
|
-
* The sink must be of type `poller` to use the poller endpoint.
|
|
3126
|
-
*/
|
|
3127
|
-
get(streamId: string, sinkId: string, options?: StreamingEventsGetOptions): Promise<EventStreamOut>;
|
|
3128
|
-
/** Creates events on the Stream. */
|
|
3129
|
-
create(streamId: string, createStreamEventsIn: CreateStreamEventsIn, options?: StreamingEventsCreateOptions): Promise<CreateStreamEventsOut>;
|
|
3130
|
-
}
|
|
3131
|
-
//#endregion
|
|
3132
|
-
//#region src/models/azureBlobStorageConfigOut.d.ts
|
|
3133
|
-
interface AzureBlobStorageConfigOut {
|
|
3134
|
-
container: string;
|
|
3135
|
-
account: string;
|
|
3136
|
-
}
|
|
3137
|
-
//#endregion
|
|
3138
|
-
//#region src/models/bigQueryConfigOut.d.ts
|
|
3139
|
-
interface BigQueryConfigOut {
|
|
3140
|
-
projectId: string;
|
|
3141
|
-
datasetId: string;
|
|
3142
|
-
tableId: string;
|
|
3143
|
-
}
|
|
3144
|
-
//#endregion
|
|
3145
|
-
//#region src/models/clickhouseConfigOut.d.ts
|
|
3146
|
-
interface ClickhouseConfigOut {
|
|
3147
|
-
url: string;
|
|
3148
|
-
username: string;
|
|
3149
|
-
database: string;
|
|
3150
|
-
tableName: string;
|
|
3151
|
-
}
|
|
3152
|
-
//#endregion
|
|
3153
|
-
//#region src/models/eventBridgeConfigOut.d.ts
|
|
3154
|
-
interface EventBridgeConfigOut {
|
|
3155
|
-
eventBusName: string;
|
|
3156
|
-
detailType: string;
|
|
3157
|
-
accessKeyId: string;
|
|
3158
|
-
region: string;
|
|
3159
|
-
}
|
|
3160
|
-
//#endregion
|
|
3161
|
-
//#region src/models/googleCloudPubSubConfigOut.d.ts
|
|
3162
|
-
interface GoogleCloudPubSubConfigOut {
|
|
3163
|
-
projectId: string;
|
|
3164
|
-
topicId: string;
|
|
3165
|
-
}
|
|
3166
|
-
//#endregion
|
|
3167
|
-
//#region src/models/googleCloudStorageConfigOut.d.ts
|
|
3168
|
-
interface GoogleCloudStorageConfigOut {
|
|
3169
|
-
bucket: string;
|
|
3170
|
-
}
|
|
3171
|
-
//#endregion
|
|
3172
|
-
//#region src/models/otelTracingConfigOut.d.ts
|
|
3173
|
-
interface OtelTracingConfigOut {
|
|
3174
|
-
url: string;
|
|
3175
|
-
headers: EndpointHeadersOut;
|
|
3176
|
-
}
|
|
3177
|
-
//#endregion
|
|
3178
|
-
//#region src/models/postgresConfigOut.d.ts
|
|
3179
|
-
interface PostgresConfigOut {
|
|
3180
|
-
url: string;
|
|
3181
|
-
tableName: string;
|
|
3182
|
-
sslRootCert?: string | null;
|
|
3183
|
-
}
|
|
3184
|
-
//#endregion
|
|
3185
|
-
//#region src/models/rabbitMqConfigOut.d.ts
|
|
3186
|
-
interface RabbitMqConfigOut {
|
|
3187
|
-
routingKey: string;
|
|
3188
|
-
}
|
|
3189
|
-
//#endregion
|
|
3190
|
-
//#region src/models/redshiftConfigOut.d.ts
|
|
3191
|
-
interface RedshiftConfigOut {
|
|
3192
|
-
accessKeyId: string;
|
|
3193
|
-
region: string;
|
|
3194
|
-
clusterIdentifier?: string | null;
|
|
3195
|
-
dbUser?: string | null;
|
|
3196
|
-
workgroupName?: string | null;
|
|
3197
|
-
/**
|
|
3198
|
-
* Database name.
|
|
3199
|
-
*
|
|
3200
|
-
* Only required if not using transformations.
|
|
3201
|
-
*/
|
|
3202
|
-
dbName?: string;
|
|
3203
|
-
/**
|
|
3204
|
-
* Schema name.
|
|
3205
|
-
*
|
|
3206
|
-
* Only used if not using transformations.
|
|
3207
|
-
*/
|
|
3208
|
-
schemaName?: string | null;
|
|
3209
|
-
/**
|
|
3210
|
-
* Table name.
|
|
3211
|
-
*
|
|
3212
|
-
* Only required if not using transformations.
|
|
3213
|
-
*/
|
|
3214
|
-
tableName?: string;
|
|
3215
|
-
}
|
|
3216
|
-
//#endregion
|
|
3217
|
-
//#region src/models/s3ConfigOut.d.ts
|
|
3218
|
-
interface S3ConfigOut {
|
|
3219
|
-
bucket: string;
|
|
3220
|
-
accessKeyId?: string | null;
|
|
3221
|
-
region: string;
|
|
3222
|
-
endpointUrl?: string | null;
|
|
3223
|
-
roleArn?: string | null;
|
|
3224
|
-
externalId?: string | null;
|
|
3225
|
-
}
|
|
3226
|
-
//#endregion
|
|
3227
|
-
//#region src/models/sinkHttpConfigOut.d.ts
|
|
3228
|
-
interface SinkHttpConfigOut {
|
|
3229
|
-
url: string;
|
|
3230
|
-
headers: EndpointHeadersOut;
|
|
3231
|
-
}
|
|
3232
|
-
//#endregion
|
|
3233
|
-
//#region src/models/sinkStatus.d.ts
|
|
3234
|
-
declare enum SinkStatus {
|
|
3235
|
-
Enabled = "enabled",
|
|
3236
|
-
Paused = "paused",
|
|
3237
|
-
Disabled = "disabled",
|
|
3238
|
-
Retrying = "retrying"
|
|
3239
|
-
}
|
|
3240
|
-
//#endregion
|
|
3241
|
-
//#region src/models/snowflakeConfigOut.d.ts
|
|
3242
|
-
interface SnowflakeConfigOut {
|
|
3243
|
-
accountIdentifier: string;
|
|
3244
|
-
userId: string;
|
|
3245
|
-
/**
|
|
3246
|
-
* Database name.
|
|
3247
|
-
*
|
|
3248
|
-
* Only required if not using transformations.
|
|
3249
|
-
*/
|
|
3250
|
-
dbName?: string;
|
|
3251
|
-
/**
|
|
3252
|
-
* Schema name.
|
|
3253
|
-
*
|
|
3254
|
-
* Only required if not using transformations.
|
|
3255
|
-
*/
|
|
3256
|
-
schemaName?: string;
|
|
4144
|
+
}
|
|
4145
|
+
declare class StreamingEvents {
|
|
4146
|
+
private readonly requestCtx;
|
|
4147
|
+
constructor(requestCtx: SvixRequestContext);
|
|
3257
4148
|
/**
|
|
3258
|
-
*
|
|
4149
|
+
* Iterate over a stream of events.
|
|
3259
4150
|
*
|
|
3260
|
-
*
|
|
4151
|
+
* The sink must be of type `poller` to use the poller endpoint.
|
|
3261
4152
|
*/
|
|
3262
|
-
|
|
3263
|
-
|
|
3264
|
-
|
|
3265
|
-
//#region src/models/snsConfigOut.d.ts
|
|
3266
|
-
interface SnsConfigOut {
|
|
3267
|
-
topicArn: string;
|
|
3268
|
-
region: string;
|
|
3269
|
-
accessKeyId: string;
|
|
4153
|
+
get(streamId: string, sinkId: string, options?: StreamingEventsGetOptions): Promise<EventStreamOut>;
|
|
4154
|
+
/** Creates events on the Stream. */
|
|
4155
|
+
create(streamId: string, createStreamEventsIn: CreateStreamEventsIn, options?: StreamingEventsCreateOptions): Promise<CreateStreamEventsOut>;
|
|
3270
4156
|
}
|
|
3271
4157
|
//#endregion
|
|
3272
|
-
//#region src/models/
|
|
3273
|
-
|
|
3274
|
-
|
|
3275
|
-
|
|
3276
|
-
|
|
3277
|
-
|
|
4158
|
+
//#region src/models/sinkStatus.d.ts
|
|
4159
|
+
declare enum SinkStatus {
|
|
4160
|
+
Enabled = "enabled",
|
|
4161
|
+
Paused = "paused",
|
|
4162
|
+
Disabled = "disabled",
|
|
4163
|
+
Retrying = "retrying"
|
|
3278
4164
|
}
|
|
3279
4165
|
//#endregion
|
|
3280
4166
|
//#region src/models/streamSinkOut.d.ts
|
|
@@ -3298,10 +4184,15 @@ interface _StreamSinkOutFields {
|
|
|
3298
4184
|
};
|
|
3299
4185
|
}
|
|
3300
4186
|
interface StreamSinkOutPollerConfig {}
|
|
4187
|
+
interface StreamSinkOutPollingEndpointConfig {}
|
|
3301
4188
|
interface StreamSinkOutPoller {
|
|
3302
4189
|
type: "poller";
|
|
3303
4190
|
config?: StreamSinkOutPollerConfig;
|
|
3304
4191
|
}
|
|
4192
|
+
interface StreamSinkOutPollingEndpoint {
|
|
4193
|
+
type: "pollingEndpoint";
|
|
4194
|
+
config?: StreamSinkOutPollingEndpointConfig;
|
|
4195
|
+
}
|
|
3305
4196
|
interface StreamSinkOutAzureBlobStorage {
|
|
3306
4197
|
type: "azureBlobStorage";
|
|
3307
4198
|
config: AzureBlobStorageConfigOut;
|
|
@@ -3360,239 +4251,27 @@ interface StreamSinkOutSns {
|
|
|
3360
4251
|
}
|
|
3361
4252
|
interface StreamSinkOutPostgres {
|
|
3362
4253
|
type: "postgres";
|
|
3363
|
-
config: PostgresConfigOut;
|
|
3364
|
-
}
|
|
3365
|
-
type StreamSinkOut = _StreamSinkOutFields & (StreamSinkOutPoller | StreamSinkOutAzureBlobStorage | StreamSinkOutOtelTracing | StreamSinkOutHttp | StreamSinkOutAmazonS3 | StreamSinkOutSnowflake | StreamSinkOutGoogleCloudStorage | StreamSinkOutGoogleCloudPubSub | StreamSinkOutRedshift | StreamSinkOutBigQuery | StreamSinkOutClickhouse | StreamSinkOutRabbitMq | StreamSinkOutSqs | StreamSinkOutEventBridge | StreamSinkOutSns | StreamSinkOutPostgres);
|
|
3366
|
-
//#endregion
|
|
3367
|
-
//#region src/models/listResponseStreamSinkOut.d.ts
|
|
3368
|
-
interface ListResponseStreamSinkOut {
|
|
3369
|
-
data: StreamSinkOut[];
|
|
3370
|
-
iterator: string | null;
|
|
3371
|
-
prevIterator?: string | null;
|
|
3372
|
-
done: boolean;
|
|
3373
|
-
}
|
|
3374
|
-
//#endregion
|
|
3375
|
-
//#region src/models/sinkSecretOut.d.ts
|
|
3376
|
-
interface SinkSecretOut {
|
|
3377
|
-
/**
|
|
3378
|
-
* The endpoint's verification secret.
|
|
3379
|
-
*
|
|
3380
|
-
* Format: `base64` encoded random bytes optionally prefixed with `whsec_`.
|
|
3381
|
-
* It is recommended to not set this and let the server generate the secret.
|
|
3382
|
-
*/
|
|
3383
|
-
key?: string | null;
|
|
3384
|
-
}
|
|
3385
|
-
//#endregion
|
|
3386
|
-
//#region src/models/azureBlobStorageConfigIn.d.ts
|
|
3387
|
-
interface AzureBlobStorageConfigIn {
|
|
3388
|
-
container: string;
|
|
3389
|
-
account: string;
|
|
3390
|
-
/**
|
|
3391
|
-
* Access key.
|
|
3392
|
-
*
|
|
3393
|
-
* Currently a required field, but marked as optional because we may add different authentication in the future.
|
|
3394
|
-
*/
|
|
3395
|
-
accessKey?: string | null;
|
|
3396
|
-
}
|
|
3397
|
-
//#endregion
|
|
3398
|
-
//#region src/models/bigQueryConfigIn.d.ts
|
|
3399
|
-
/** Configuration for a Google Cloud BigQuery sink. */
|
|
3400
|
-
interface BigQueryConfigIn {
|
|
3401
|
-
projectId: string;
|
|
3402
|
-
datasetId: string;
|
|
3403
|
-
tableId: string;
|
|
3404
|
-
/** Google Cloud Credentials JSON Object as a string. */
|
|
3405
|
-
credentials: string;
|
|
3406
|
-
}
|
|
3407
|
-
//#endregion
|
|
3408
|
-
//#region src/models/clickhouseConfigIn.d.ts
|
|
3409
|
-
interface ClickhouseConfigIn {
|
|
3410
|
-
/** The HTTP URL of the ClickHouse server (e.g. `https://my_clickhouse:8443`). */
|
|
3411
|
-
url: string;
|
|
3412
|
-
/**
|
|
3413
|
-
* Username to access Clickhouse.
|
|
3414
|
-
*
|
|
3415
|
-
* Currently a required field, but marked as optional because we may add different authentication in the future.
|
|
3416
|
-
*/
|
|
3417
|
-
username?: string | null;
|
|
3418
|
-
/**
|
|
3419
|
-
* Password to access Clickhouse.
|
|
3420
|
-
*
|
|
3421
|
-
* Currently a required field, but marked as optional because we may add different authentication in the future.
|
|
3422
|
-
*/
|
|
3423
|
-
password?: string | null;
|
|
3424
|
-
/** The Clickhouse database to connect to. */
|
|
3425
|
-
database?: string;
|
|
3426
|
-
/** The Clickhouse table to write to. */
|
|
3427
|
-
tableName: string;
|
|
3428
|
-
}
|
|
3429
|
-
//#endregion
|
|
3430
|
-
//#region src/models/eventBridgeConfigIn.d.ts
|
|
3431
|
-
interface EventBridgeConfigIn {
|
|
3432
|
-
/** The name or ARN of the event bus to receive the event */
|
|
3433
|
-
eventBusName: string;
|
|
3434
|
-
/** Free-form string, with a maximum of 128 characters */
|
|
3435
|
-
detailType?: string;
|
|
3436
|
-
/**
|
|
3437
|
-
* Access key ID.
|
|
3438
|
-
*
|
|
3439
|
-
* Currently a required field, but marked as optional because we may add different authentication in the future.
|
|
3440
|
-
*/
|
|
3441
|
-
accessKeyId?: string | null;
|
|
3442
|
-
/**
|
|
3443
|
-
* Secret access key.
|
|
3444
|
-
*
|
|
3445
|
-
* Currently a required field, but marked as optional because we may add different authentication in the future.
|
|
3446
|
-
*/
|
|
3447
|
-
secretAccessKey?: string | null;
|
|
3448
|
-
/**
|
|
3449
|
-
* The region of the EventBridge bus.
|
|
3450
|
-
*
|
|
3451
|
-
* Currently a required field, but marked as optional because we may infer it from other fields in the future.
|
|
3452
|
-
*/
|
|
3453
|
-
region?: string | null;
|
|
3454
|
-
}
|
|
3455
|
-
//#endregion
|
|
3456
|
-
//#region src/models/googleCloudPubSubConfigIn.d.ts
|
|
3457
|
-
interface GoogleCloudPubSubConfigIn {
|
|
3458
|
-
projectId: string;
|
|
3459
|
-
topicId: string;
|
|
3460
|
-
/** Google Cloud Credentials JSON Object as a string. */
|
|
3461
|
-
credentials: string;
|
|
3462
|
-
}
|
|
3463
|
-
//#endregion
|
|
3464
|
-
//#region src/models/googleCloudStorageConfigIn.d.ts
|
|
3465
|
-
/**
|
|
3466
|
-
* Configuration for a Google Cloud Storage sink.
|
|
3467
|
-
*
|
|
3468
|
-
* Write stream events into the named bucket using the supplied Google Cloud credentials.
|
|
3469
|
-
*/
|
|
3470
|
-
interface GoogleCloudStorageConfigIn {
|
|
3471
|
-
bucket: string;
|
|
3472
|
-
/** Google Cloud Credentials JSON Object as a string. */
|
|
3473
|
-
credentials: string;
|
|
3474
|
-
}
|
|
3475
|
-
//#endregion
|
|
3476
|
-
//#region src/models/otelTracingConfigIn.d.ts
|
|
3477
|
-
interface OtelTracingConfigIn {
|
|
3478
|
-
url: string;
|
|
3479
|
-
headers?: {
|
|
3480
|
-
[key: string]: string;
|
|
3481
|
-
};
|
|
3482
|
-
}
|
|
3483
|
-
//#endregion
|
|
3484
|
-
//#region src/models/postgresConfigIn.d.ts
|
|
3485
|
-
interface PostgresConfigIn {
|
|
3486
|
-
/**
|
|
3487
|
-
* PostgreSQL connection URL, e.g. `postgres://user@host:5432/dbname?sslmode=require`.
|
|
3488
|
-
*
|
|
3489
|
-
* Do NOT embed a password here; use the `password` field instead.
|
|
3490
|
-
*/
|
|
3491
|
-
url: string;
|
|
3492
|
-
/** Password for the connection. */
|
|
3493
|
-
password?: string | null;
|
|
3494
|
-
/**
|
|
3495
|
-
* Table to insert into. May be schema-qualified (e.g. `public.events`).
|
|
3496
|
-
*
|
|
3497
|
-
* Quote characters are not supported. Each dot-separated segment is automatically double-quoted when the query is built, so `public.events` becomes `"public"."events"`.
|
|
3498
|
-
*/
|
|
3499
|
-
tableName: string;
|
|
3500
|
-
/**
|
|
3501
|
-
* PEM-encoded CA certificate used to verify the Postgres server's TLS certificate.
|
|
3502
|
-
*
|
|
3503
|
-
* 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.
|
|
3504
|
-
*/
|
|
3505
|
-
sslRootCert?: string | null;
|
|
3506
|
-
}
|
|
3507
|
-
//#endregion
|
|
3508
|
-
//#region src/models/rabbitMqConfigIn.d.ts
|
|
3509
|
-
/** Configuration for a RabbitMq sink. */
|
|
3510
|
-
interface RabbitMqConfigIn {
|
|
3511
|
-
uri: string;
|
|
3512
|
-
routingKey: string;
|
|
3513
|
-
}
|
|
3514
|
-
//#endregion
|
|
3515
|
-
//#region src/models/redshiftConfigIn.d.ts
|
|
3516
|
-
/**
|
|
3517
|
-
* Configuration parameters for defining a Redshift sink.
|
|
3518
|
-
*
|
|
3519
|
-
* For provisioned clusters, set `cluster_identifier` and `db_user`. For Redshift Serverless, set `workgroup_name`.
|
|
3520
|
-
*/
|
|
3521
|
-
interface RedshiftConfigIn {
|
|
3522
|
-
/**
|
|
3523
|
-
* Access key ID.
|
|
3524
|
-
*
|
|
3525
|
-
* Currently a required field, but marked as optional because we may add different authentication in the future.
|
|
3526
|
-
*/
|
|
3527
|
-
accessKeyId?: string | null;
|
|
3528
|
-
/**
|
|
3529
|
-
* Secret access key.
|
|
3530
|
-
*
|
|
3531
|
-
* Currently a required field, but marked as optional because we may add different authentication in the future.
|
|
3532
|
-
*/
|
|
3533
|
-
secretAccessKey?: string | null;
|
|
3534
|
-
/**
|
|
3535
|
-
* The region of the Redshift DB.
|
|
3536
|
-
*
|
|
3537
|
-
* Currently a required field, but marked as optional because we may infer it from other fields in the future.
|
|
3538
|
-
*/
|
|
3539
|
-
region?: string | null;
|
|
3540
|
-
/** Required for provisioned clusters. */
|
|
3541
|
-
clusterIdentifier?: string | null;
|
|
3542
|
-
/** Required for provisioned clusters. */
|
|
3543
|
-
dbUser?: string | null;
|
|
3544
|
-
/** Required for Redshift Serverless. */
|
|
3545
|
-
workgroupName?: string | null;
|
|
3546
|
-
/**
|
|
3547
|
-
* Database name.
|
|
3548
|
-
*
|
|
3549
|
-
* Only required if not using transformations.
|
|
3550
|
-
*/
|
|
3551
|
-
dbName?: string;
|
|
3552
|
-
/**
|
|
3553
|
-
* Schema name.
|
|
3554
|
-
*
|
|
3555
|
-
* Only used if not using transformations.
|
|
3556
|
-
*/
|
|
3557
|
-
schemaName?: string | null;
|
|
3558
|
-
/**
|
|
3559
|
-
* Table name.
|
|
3560
|
-
*
|
|
3561
|
-
* Only required if not using transformations.
|
|
3562
|
-
*/
|
|
3563
|
-
tableName?: string;
|
|
3564
|
-
}
|
|
3565
|
-
//#endregion
|
|
3566
|
-
//#region src/models/s3ConfigIn.d.ts
|
|
3567
|
-
interface S3ConfigIn {
|
|
3568
|
-
bucket: string;
|
|
3569
|
-
/**
|
|
3570
|
-
* Access key ID.
|
|
3571
|
-
*
|
|
3572
|
-
* Required (along with `secret_access_key`) if `role_arn` is null
|
|
3573
|
-
*/
|
|
3574
|
-
accessKeyId?: string | null;
|
|
3575
|
-
/**
|
|
3576
|
-
* Secret access key.
|
|
3577
|
-
*
|
|
3578
|
-
* Required (along with `access_key_id`) if `role_arn` is null
|
|
3579
|
-
*/
|
|
3580
|
-
secretAccessKey?: string | null;
|
|
3581
|
-
/**
|
|
3582
|
-
* The region of the S3 bucket
|
|
3583
|
-
*
|
|
3584
|
-
* Currently a required field, but marked as optional because we may infer it from other fields in the future.
|
|
3585
|
-
*/
|
|
3586
|
-
region?: string | null;
|
|
3587
|
-
endpointUrl?: string | null;
|
|
3588
|
-
/** Role ARN for delegated authentication */
|
|
3589
|
-
roleArn?: string | null;
|
|
4254
|
+
config: PostgresConfigOut;
|
|
4255
|
+
}
|
|
4256
|
+
type StreamSinkOut = _StreamSinkOutFields & (StreamSinkOutPoller | StreamSinkOutPollingEndpoint | StreamSinkOutAzureBlobStorage | StreamSinkOutOtelTracing | StreamSinkOutHttp | StreamSinkOutAmazonS3 | StreamSinkOutSnowflake | StreamSinkOutGoogleCloudStorage | StreamSinkOutGoogleCloudPubSub | StreamSinkOutRedshift | StreamSinkOutBigQuery | StreamSinkOutClickhouse | StreamSinkOutRabbitMq | StreamSinkOutSqs | StreamSinkOutEventBridge | StreamSinkOutSns | StreamSinkOutPostgres);
|
|
4257
|
+
//#endregion
|
|
4258
|
+
//#region src/models/listResponseStreamSinkOut.d.ts
|
|
4259
|
+
interface ListResponseStreamSinkOut {
|
|
4260
|
+
data: StreamSinkOut[];
|
|
4261
|
+
iterator: string | null;
|
|
4262
|
+
prevIterator?: string | null;
|
|
4263
|
+
done: boolean;
|
|
4264
|
+
}
|
|
4265
|
+
//#endregion
|
|
4266
|
+
//#region src/models/sinkSecretOut.d.ts
|
|
4267
|
+
interface SinkSecretOut {
|
|
3590
4268
|
/**
|
|
3591
|
-
*
|
|
4269
|
+
* The endpoint's verification secret.
|
|
3592
4270
|
*
|
|
3593
|
-
*
|
|
4271
|
+
* Format: `base64` encoded random bytes optionally prefixed with `whsec_`.
|
|
4272
|
+
* It is recommended to not set this and let the server generate the secret.
|
|
3594
4273
|
*/
|
|
3595
|
-
|
|
4274
|
+
key?: string | null;
|
|
3596
4275
|
}
|
|
3597
4276
|
//#endregion
|
|
3598
4277
|
//#region src/models/sinkHttpConfigIn.d.ts
|
|
@@ -3610,91 +4289,6 @@ declare enum SinkStatusIn {
|
|
|
3610
4289
|
Disabled = "disabled"
|
|
3611
4290
|
}
|
|
3612
4291
|
//#endregion
|
|
3613
|
-
//#region src/models/snowflakeConfigIn.d.ts
|
|
3614
|
-
/** Configuration parameters for defining a Snowflake sink. */
|
|
3615
|
-
interface SnowflakeConfigIn {
|
|
3616
|
-
/**
|
|
3617
|
-
* PEM-encoded private key used for signing token-based requests to the Snowflake API.
|
|
3618
|
-
*
|
|
3619
|
-
* Beginning/end delimiters are not required.
|
|
3620
|
-
*
|
|
3621
|
-
* Currently a required field, but marked as optional because we may add different authentication in the future.
|
|
3622
|
-
*/
|
|
3623
|
-
privateKey?: string | null;
|
|
3624
|
-
/** Snowflake account identifier, which includes both the organization and account IDs separated by a hyphen. */
|
|
3625
|
-
accountIdentifier: string;
|
|
3626
|
-
/** The Snowflake user id. */
|
|
3627
|
-
userId: string;
|
|
3628
|
-
/**
|
|
3629
|
-
* Database name.
|
|
3630
|
-
*
|
|
3631
|
-
* Only required if not using transformations.
|
|
3632
|
-
*/
|
|
3633
|
-
dbName?: string;
|
|
3634
|
-
/**
|
|
3635
|
-
* Schema name.
|
|
3636
|
-
*
|
|
3637
|
-
* Only required if not using transformations.
|
|
3638
|
-
*/
|
|
3639
|
-
schemaName?: string;
|
|
3640
|
-
/**
|
|
3641
|
-
* Table name.
|
|
3642
|
-
*
|
|
3643
|
-
* Only required if not using transformations.
|
|
3644
|
-
*/
|
|
3645
|
-
tableName?: string;
|
|
3646
|
-
}
|
|
3647
|
-
//#endregion
|
|
3648
|
-
//#region src/models/snsConfigIn.d.ts
|
|
3649
|
-
/** Configuration for a SNS sink. */
|
|
3650
|
-
interface SnsConfigIn {
|
|
3651
|
-
topicArn: string;
|
|
3652
|
-
/**
|
|
3653
|
-
* The region of the SNS instance.
|
|
3654
|
-
*
|
|
3655
|
-
* Currently a required field, but marked as optional because we may infer it from other fields in the future.
|
|
3656
|
-
*/
|
|
3657
|
-
region?: string | null;
|
|
3658
|
-
/**
|
|
3659
|
-
* Access key ID.
|
|
3660
|
-
*
|
|
3661
|
-
* Currently a required field, but marked as optional because we may add different authentication in the future.
|
|
3662
|
-
*/
|
|
3663
|
-
accessKeyId?: string | null;
|
|
3664
|
-
/**
|
|
3665
|
-
* Secret access key.
|
|
3666
|
-
*
|
|
3667
|
-
* Currently a required field, but marked as optional because we may add different authentication in the future.
|
|
3668
|
-
*/
|
|
3669
|
-
secretAccessKey?: string | null;
|
|
3670
|
-
endpointUrl?: string | null;
|
|
3671
|
-
}
|
|
3672
|
-
//#endregion
|
|
3673
|
-
//#region src/models/sqsConfigIn.d.ts
|
|
3674
|
-
/** Configuration for an SQS sink. */
|
|
3675
|
-
interface SqsConfigIn {
|
|
3676
|
-
queueUrl: string;
|
|
3677
|
-
/**
|
|
3678
|
-
* The region of the SQS queue.
|
|
3679
|
-
*
|
|
3680
|
-
* Currently a required field, but marked as optional because we may infer it from other fields in the future.
|
|
3681
|
-
*/
|
|
3682
|
-
region?: string | null;
|
|
3683
|
-
/**
|
|
3684
|
-
* Access key ID.
|
|
3685
|
-
*
|
|
3686
|
-
* Currently a required field, but marked as optional because we may add different authentication in the future.
|
|
3687
|
-
*/
|
|
3688
|
-
accessKeyId?: string | null;
|
|
3689
|
-
/**
|
|
3690
|
-
* Secret access key.
|
|
3691
|
-
*
|
|
3692
|
-
* Currently a required field, but marked as optional because we may add different authentication in the future.
|
|
3693
|
-
*/
|
|
3694
|
-
secretAccessKey?: string | null;
|
|
3695
|
-
endpointUrl?: string | null;
|
|
3696
|
-
}
|
|
3697
|
-
//#endregion
|
|
3698
4292
|
//#region src/models/streamSinkIn.d.ts
|
|
3699
4293
|
interface _StreamSinkInFields {
|
|
3700
4294
|
/** An optional unique identifier for the sink. */
|
|
@@ -3791,155 +4385,6 @@ interface StreamSinkInPostgres {
|
|
|
3791
4385
|
}
|
|
3792
4386
|
type StreamSinkIn = _StreamSinkInFields & (StreamSinkInPoller | StreamSinkInAzureBlobStorage | StreamSinkInOtelTracing | StreamSinkInHttp | StreamSinkInAmazonS3 | StreamSinkInGoogleCloudStorage | StreamSinkInGoogleCloudPubSub | StreamSinkInSqs | StreamSinkInSns | StreamSinkInBigQuery | StreamSinkInClickhouse | StreamSinkInEventBridge | StreamSinkInSnowflake | StreamSinkInRabbitMq | StreamSinkInRedshift | StreamSinkInPostgres);
|
|
3793
4387
|
//#endregion
|
|
3794
|
-
//#region src/models/azureBlobStorageConfigPatch.d.ts
|
|
3795
|
-
interface AzureBlobStorageConfigPatch {
|
|
3796
|
-
container?: string;
|
|
3797
|
-
account?: string;
|
|
3798
|
-
accessKey?: string;
|
|
3799
|
-
}
|
|
3800
|
-
//#endregion
|
|
3801
|
-
//#region src/models/bigQueryConfigPatch.d.ts
|
|
3802
|
-
interface BigQueryConfigPatch {
|
|
3803
|
-
projectId?: string;
|
|
3804
|
-
datasetId?: string;
|
|
3805
|
-
tableId?: string;
|
|
3806
|
-
credentials?: string;
|
|
3807
|
-
}
|
|
3808
|
-
//#endregion
|
|
3809
|
-
//#region src/models/clickhouseConfigPatch.d.ts
|
|
3810
|
-
interface ClickhouseConfigPatch {
|
|
3811
|
-
url?: string;
|
|
3812
|
-
username?: string;
|
|
3813
|
-
password?: string;
|
|
3814
|
-
database?: string;
|
|
3815
|
-
tableName?: string;
|
|
3816
|
-
}
|
|
3817
|
-
//#endregion
|
|
3818
|
-
//#region src/models/eventBridgeConfigPatch.d.ts
|
|
3819
|
-
interface EventBridgeConfigPatch {
|
|
3820
|
-
eventBusName?: string;
|
|
3821
|
-
detailType?: string;
|
|
3822
|
-
accessKeyId?: string;
|
|
3823
|
-
secretAccessKey?: string;
|
|
3824
|
-
region?: string;
|
|
3825
|
-
}
|
|
3826
|
-
//#endregion
|
|
3827
|
-
//#region src/models/googleCloudPubSubConfigPatch.d.ts
|
|
3828
|
-
interface GoogleCloudPubSubConfigPatch {
|
|
3829
|
-
projectId?: string;
|
|
3830
|
-
topicId?: string;
|
|
3831
|
-
credentials?: string;
|
|
3832
|
-
}
|
|
3833
|
-
//#endregion
|
|
3834
|
-
//#region src/models/googleCloudStorageConfigPatch.d.ts
|
|
3835
|
-
interface GoogleCloudStorageConfigPatch {
|
|
3836
|
-
bucket?: string;
|
|
3837
|
-
credentials?: string;
|
|
3838
|
-
}
|
|
3839
|
-
//#endregion
|
|
3840
|
-
//#region src/models/otelTracingConfigPatch.d.ts
|
|
3841
|
-
interface OtelTracingConfigPatch {
|
|
3842
|
-
url?: string;
|
|
3843
|
-
}
|
|
3844
|
-
//#endregion
|
|
3845
|
-
//#region src/models/postgresConfigPatch.d.ts
|
|
3846
|
-
interface PostgresConfigPatch {
|
|
3847
|
-
url?: string;
|
|
3848
|
-
password?: string;
|
|
3849
|
-
tableName?: string;
|
|
3850
|
-
sslRootCert?: string;
|
|
3851
|
-
}
|
|
3852
|
-
//#endregion
|
|
3853
|
-
//#region src/models/rabbitMqConfigPatch.d.ts
|
|
3854
|
-
interface RabbitMqConfigPatch {
|
|
3855
|
-
routingKey?: string;
|
|
3856
|
-
uri?: string;
|
|
3857
|
-
}
|
|
3858
|
-
//#endregion
|
|
3859
|
-
//#region src/models/redshiftConfigPatch.d.ts
|
|
3860
|
-
interface RedshiftConfigPatch {
|
|
3861
|
-
accessKeyId?: string;
|
|
3862
|
-
secretAccessKey?: string;
|
|
3863
|
-
region?: string;
|
|
3864
|
-
/**
|
|
3865
|
-
* Database name.
|
|
3866
|
-
*
|
|
3867
|
-
* Only required if not using transformations.
|
|
3868
|
-
*/
|
|
3869
|
-
dbName?: string;
|
|
3870
|
-
/**
|
|
3871
|
-
* Schema name.
|
|
3872
|
-
*
|
|
3873
|
-
* Only used if not using transformations.
|
|
3874
|
-
*/
|
|
3875
|
-
schemaName?: string | null;
|
|
3876
|
-
/**
|
|
3877
|
-
* Table name.
|
|
3878
|
-
*
|
|
3879
|
-
* Only required if not using transformations.
|
|
3880
|
-
*/
|
|
3881
|
-
tableName?: string;
|
|
3882
|
-
}
|
|
3883
|
-
//#endregion
|
|
3884
|
-
//#region src/models/s3ConfigPatch.d.ts
|
|
3885
|
-
interface S3ConfigPatch {
|
|
3886
|
-
bucket?: string;
|
|
3887
|
-
accessKeyId?: string;
|
|
3888
|
-
secretAccessKey?: string;
|
|
3889
|
-
roleArn?: string;
|
|
3890
|
-
externalId?: string;
|
|
3891
|
-
region?: string;
|
|
3892
|
-
endpointUrl?: string;
|
|
3893
|
-
}
|
|
3894
|
-
//#endregion
|
|
3895
|
-
//#region src/models/sinkHttpConfigPatch.d.ts
|
|
3896
|
-
interface SinkHttpConfigPatch {
|
|
3897
|
-
url?: string;
|
|
3898
|
-
}
|
|
3899
|
-
//#endregion
|
|
3900
|
-
//#region src/models/snowflakeConfigPatch.d.ts
|
|
3901
|
-
interface SnowflakeConfigPatch {
|
|
3902
|
-
privateKey?: string;
|
|
3903
|
-
accountIdentifier?: string;
|
|
3904
|
-
userId?: string;
|
|
3905
|
-
/**
|
|
3906
|
-
* Database name.
|
|
3907
|
-
*
|
|
3908
|
-
* Only required if not using transformations.
|
|
3909
|
-
*/
|
|
3910
|
-
dbName?: string;
|
|
3911
|
-
/**
|
|
3912
|
-
* Schema name.
|
|
3913
|
-
*
|
|
3914
|
-
* Only required if not using transformations.
|
|
3915
|
-
*/
|
|
3916
|
-
schemaName?: string;
|
|
3917
|
-
/**
|
|
3918
|
-
* Table name.
|
|
3919
|
-
*
|
|
3920
|
-
* Only required if not using transformations.
|
|
3921
|
-
*/
|
|
3922
|
-
tableName?: string;
|
|
3923
|
-
}
|
|
3924
|
-
//#endregion
|
|
3925
|
-
//#region src/models/snsConfigPatch.d.ts
|
|
3926
|
-
interface SnsConfigPatch {
|
|
3927
|
-
topicArn?: string;
|
|
3928
|
-
region?: string;
|
|
3929
|
-
accessKeyId?: string;
|
|
3930
|
-
secretAccessKey?: string;
|
|
3931
|
-
endpointUrl?: string | null;
|
|
3932
|
-
}
|
|
3933
|
-
//#endregion
|
|
3934
|
-
//#region src/models/sqsConfigPatch.d.ts
|
|
3935
|
-
interface SqsConfigPatch {
|
|
3936
|
-
queueUrl?: string;
|
|
3937
|
-
region?: string;
|
|
3938
|
-
accessKeyId?: string;
|
|
3939
|
-
secretAccessKey?: string;
|
|
3940
|
-
endpointUrl?: string | null;
|
|
3941
|
-
}
|
|
3942
|
-
//#endregion
|
|
3943
4388
|
//#region src/models/streamSinkPatch.d.ts
|
|
3944
4389
|
interface _StreamSinkPatchFields {
|
|
3945
4390
|
/** The StreamSink's UID. */
|
|
@@ -4270,10 +4715,11 @@ declare class AutoConfigError extends Error {
|
|
|
4270
4715
|
}
|
|
4271
4716
|
declare class AutoConfig {
|
|
4272
4717
|
private readonly appId;
|
|
4273
|
-
private readonly endpointId;
|
|
4274
|
-
private readonly endpointIn;
|
|
4275
4718
|
private readonly webhook;
|
|
4276
4719
|
private readonly requestCtx;
|
|
4720
|
+
private readonly endpointIn;
|
|
4721
|
+
private readonly endpointId?;
|
|
4722
|
+
private readonly autoconfigId?;
|
|
4277
4723
|
constructor(token: string, endpoint: EndpointIn);
|
|
4278
4724
|
subscribe(): Promise<EndpointOut>;
|
|
4279
4725
|
verify(payload: string | Buffer, headers: WebhookRequiredHeaders | WebhookUnbrandedRequiredHeaders | Record<string, string>): unknown;
|
|
@@ -4353,11 +4799,13 @@ interface SinkInCommon {
|
|
|
4353
4799
|
//#region src/autoconfigConsumer.d.ts
|
|
4354
4800
|
declare class AutoConfigConsumer {
|
|
4355
4801
|
private readonly appId;
|
|
4356
|
-
private readonly sinkId;
|
|
4357
4802
|
private readonly sinkIn;
|
|
4358
4803
|
private readonly requestCtx;
|
|
4804
|
+
private sinkId?;
|
|
4805
|
+
private readonly autoconfigId?;
|
|
4359
4806
|
constructor(token: string, sinkIn: SinkInCommon);
|
|
4360
|
-
subscribe(): Promise<
|
|
4807
|
+
subscribe(): Promise<DestinationOut>;
|
|
4808
|
+
private getSinkId;
|
|
4361
4809
|
receive(consumerId: string, options?: MessagePollerv2ConsumerPollOptions): Promise<PollerV2PollOut>;
|
|
4362
4810
|
commit(consumerId: string, offset: number, options?: MessagePollerv2ConsumerCommitOptions): Promise<void>;
|
|
4363
4811
|
}
|
|
@@ -4388,8 +4836,10 @@ declare class Svix {
|
|
|
4388
4836
|
constructor(token: string, options?: SvixOptions);
|
|
4389
4837
|
get application(): Application;
|
|
4390
4838
|
get authentication(): Authentication;
|
|
4839
|
+
get autoconfigSubscription(): AutoconfigSubscription;
|
|
4391
4840
|
get backgroundTask(): BackgroundTask;
|
|
4392
4841
|
get connector(): Connector;
|
|
4842
|
+
get destination(): Destination;
|
|
4393
4843
|
get endpoint(): Endpoint;
|
|
4394
4844
|
get environment(): Environment;
|
|
4395
4845
|
get eventType(): EventType;
|
|
@@ -4403,5 +4853,5 @@ declare class Svix {
|
|
|
4403
4853
|
get streaming(): Streaming;
|
|
4404
4854
|
}
|
|
4405
4855
|
//#endregion
|
|
4406
|
-
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 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 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 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 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 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 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 };
|
|
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 };
|
|
4407
4857
|
//# sourceMappingURL=index.d.mts.map
|