svix 1.99.1 → 2.0.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 +4312 -0
- package/dist/index.d.mts.map +1 -0
- package/dist/index.mjs +6799 -0
- package/dist/index.mjs.map +1 -0
- package/package.json +19 -8
- package/src/KitchenSink.test.ts +3 -3
- package/src/api/application.ts +1 -1
- package/src/api/authentication.ts +0 -25
- package/src/api/backgroundTask.ts +0 -11
- package/src/api/connector.ts +6 -6
- package/src/api/endpoint.ts +12 -67
- package/src/api/endpointTransformation.ts +54 -0
- package/src/api/eventType.ts +7 -7
- package/src/api/ingest.ts +6 -38
- package/src/api/ingestAuthentication.ts +44 -0
- package/src/api/ingestEndpoint.ts +15 -57
- package/src/api/ingestEndpointTransformation.ts +56 -0
- package/src/api/ingestSource.ts +1 -1
- package/src/api/integration.ts +0 -20
- package/src/api/message.ts +19 -14
- package/src/api/messageAttempt.ts +18 -6
- package/src/api/operationalWebhookEndpoint.ts +9 -9
- package/src/api/streaming.ts +1 -24
- package/src/api/streamingEventType.ts +1 -1
- package/src/api/streamingSink.ts +6 -23
- package/src/api/streamingSinkTransformation.ts +50 -0
- package/src/api/streamingStream.ts +1 -1
- package/src/api_internal/endpoint.ts +1 -1
- package/src/api_internal/index.ts +12 -3
- package/src/autoconfig.ts +1 -1
- package/src/autoconfigConsumer.ts +1 -1
- package/src/index.test.ts +1 -0
- package/src/index.ts +2 -44
- package/src/mockttp.test.ts +18 -43
- package/src/models/apiTokenOut.ts +9 -9
- package/src/models/appPortalAccessIn.ts +12 -12
- package/src/models/appPortalAccessOut.ts +3 -3
- package/src/models/appUsageStatsIn.ts +4 -4
- package/src/models/appUsageStatsOut.ts +6 -6
- package/src/models/applicationIn.ts +3 -11
- package/src/models/applicationOut.ts +14 -22
- package/src/models/applicationPatch.ts +3 -11
- package/src/models/azureBlobStorageConfigIn.ts +30 -0
- package/src/models/azureBlobStorageConfigOut.ts +22 -0
- package/src/models/{azureBlobStoragePatchConfig.ts → azureBlobStorageConfigPatch.ts} +10 -10
- package/src/models/{bigQueryConfig.ts → bigQueryConfigIn.ts} +11 -11
- package/src/models/bigQueryConfigOut.ts +25 -0
- package/src/models/{bigQueryPatchConfig.ts → bigQueryConfigPatch.ts} +10 -10
- package/src/models/bulkReplayIn.ts +12 -12
- package/src/models/clickhouseConfigIn.ts +44 -0
- package/src/models/clickhouseConfigOut.ts +28 -0
- package/src/models/{clickhousePatchConfig.ts → clickhouseConfigPatch.ts} +13 -13
- package/src/models/connectorIn.ts +22 -22
- package/src/models/connectorOut.ts +31 -31
- package/src/models/connectorPatch.ts +15 -15
- package/src/models/{connectorUpdate.ts → connectorUpsertIn.ts} +19 -19
- package/src/models/cronConfig.ts +6 -6
- package/src/models/endpointHeadersPatchIn.ts +3 -3
- package/src/models/endpointIn.ts +26 -37
- package/src/models/endpointMessageOut.ts +22 -22
- package/src/models/endpointOut.ts +19 -31
- package/src/models/endpointPatch.ts +12 -34
- package/src/models/endpointSecretRotateIn.ts +8 -8
- package/src/models/endpointStats.ts +9 -9
- package/src/models/endpointTransformationOut.ts +3 -3
- package/src/models/{endpointUpdate.ts → endpointUpsertIn.ts} +20 -31
- package/src/models/environmentIn.ts +7 -7
- package/src/models/environmentOut.ts +10 -10
- package/src/models/eventBridgeConfigIn.ts +48 -0
- package/src/models/eventBridgeConfigOut.ts +28 -0
- package/src/models/{eventBridgePatchConfig.ts → eventBridgeConfigPatch.ts} +13 -13
- package/src/models/eventStreamOut.ts +3 -3
- package/src/models/eventTypeFromOpenApi.ts +13 -21
- package/src/models/eventTypeIn.ts +14 -22
- package/src/models/eventTypeOut.ts +20 -20
- package/src/models/eventTypePatch.ts +6 -14
- package/src/models/{eventTypeUpdate.ts → eventTypeUpsertIn.ts} +11 -19
- package/src/models/{googleCloudPubSubConfig.ts → googleCloudPubSubConfigIn.ts} +8 -8
- package/src/models/googleCloudPubSubConfigOut.ts +22 -0
- package/src/models/{googleCloudPubSubPatchConfig.ts → googleCloudPubSubConfigPatch.ts} +7 -7
- package/src/models/{googleCloudStorageConfig.ts → googleCloudStorageConfigIn.ts} +4 -4
- package/src/models/googleCloudStorageConfigOut.ts +19 -0
- package/src/models/{googleCloudStoragePatchConfig.ts → googleCloudStorageConfigPatch.ts} +4 -4
- package/src/models/index.ts +47 -65
- package/src/models/ingestEndpointIn.ts +19 -24
- package/src/models/ingestEndpointOut.ts +15 -24
- package/src/models/ingestEndpointSecretIn.ts +8 -0
- package/src/models/ingestEndpointTransformationOut.ts +3 -0
- package/src/models/ingestEndpointTransformationPatch.ts +3 -0
- package/src/models/{ingestEndpointUpdate.ts → ingestEndpointUpsertIn.ts} +13 -21
- package/src/models/ingestSourceIn.ts +3 -3
- package/src/models/ingestSourceOut.ts +12 -12
- package/src/models/integrationIn.ts +3 -3
- package/src/models/integrationOut.ts +10 -10
- package/src/models/integrationUpdate.ts +3 -3
- package/src/models/listResponseApplicationOut.ts +3 -3
- package/src/models/listResponseBackgroundTaskOut.ts +3 -3
- package/src/models/listResponseConnectorOut.ts +3 -3
- package/src/models/listResponseEndpointMessageOut.ts +3 -3
- package/src/models/listResponseEndpointOut.ts +3 -3
- package/src/models/listResponseEventTypeOut.ts +3 -3
- package/src/models/listResponseIngestEndpointOut.ts +3 -3
- package/src/models/listResponseIngestSourceOut.ts +3 -3
- package/src/models/listResponseIntegrationOut.ts +3 -3
- package/src/models/listResponseMessageAttemptOut.ts +3 -3
- package/src/models/listResponseMessageEndpointOut.ts +3 -3
- package/src/models/listResponseMessageOut.ts +3 -3
- package/src/models/listResponseOperationalWebhookEndpointOut.ts +3 -3
- package/src/models/listResponseStreamEventTypeOut.ts +3 -3
- package/src/models/listResponseStreamOut.ts +3 -3
- package/src/models/listResponseStreamSinkOut.ts +3 -3
- package/src/models/messageAttemptOut.ts +27 -27
- package/src/models/messageEndpointOut.ts +22 -34
- package/src/models/messageIn.ts +32 -32
- package/src/models/messageOut.ts +13 -13
- package/src/models/messagePrecheckIn.ts +3 -3
- package/src/models/operationalWebhookEndpointIn.ts +22 -27
- package/src/models/operationalWebhookEndpointOut.ts +18 -27
- package/src/models/operationalWebhookEndpointSecretIn.ts +8 -0
- package/src/models/{operationalWebhookEndpointUpdate.ts → operationalWebhookEndpointUpsertIn.ts} +16 -24
- package/src/models/{sinkOtelV1Config.ts → otelTracingConfigIn.ts} +7 -7
- package/src/models/otelTracingConfigOut.ts +26 -0
- package/src/models/otelTracingConfigPatch.ts +19 -0
- package/src/models/pollerV2MessageOut.ts +19 -19
- package/src/models/pollingEndpointMessageOut.ts +16 -16
- package/src/models/pollingEndpointOut.ts +3 -3
- package/src/models/{rabbitMqConfig.ts → rabbitMqConfigIn.ts} +7 -7
- package/src/models/rabbitMqConfigOut.ts +19 -0
- package/src/models/{rabbitMqPatchConfig.ts → rabbitMqConfigPatch.ts} +4 -4
- package/src/models/{redshiftConfig.ts → redshiftConfigIn.ts} +34 -19
- package/src/models/redshiftConfigOut.ts +55 -0
- package/src/models/{redshiftPatchConfig.ts → redshiftConfigPatch.ts} +10 -10
- package/src/models/s3ConfigIn.ts +46 -0
- package/src/models/{s3Config.ts → s3ConfigOut.ts} +10 -13
- package/src/models/{amazonS3PatchConfig.ts → s3ConfigPatch.ts} +13 -13
- package/src/models/{sinkHttpConfig.ts → sinkHttpConfigIn.ts} +7 -7
- package/src/models/sinkHttpConfigOut.ts +26 -0
- package/src/models/sinkHttpConfigPatch.ts +19 -0
- package/src/models/sinkInCommon.ts +20 -28
- package/src/models/{snowflakeConfig.ts → snowflakeConfigIn.ts} +18 -16
- package/src/models/snowflakeConfigOut.ts +46 -0
- package/src/models/{snowflakePatchConfig.ts → snowflakeConfigPatch.ts} +10 -10
- package/src/models/snsConfigIn.ts +47 -0
- package/src/models/snsConfigOut.ts +25 -0
- package/src/models/{snsPatchConfig.ts → snsConfigPatch.ts} +13 -13
- package/src/models/sqsConfigIn.ts +47 -0
- package/src/models/{sqsConfig.ts → sqsConfigOut.ts} +10 -14
- package/src/models/{sqsPatchConfig.ts → sqsConfigPatch.ts} +10 -10
- package/src/models/streamEventTypeIn.ts +10 -10
- package/src/models/streamEventTypeOut.ts +13 -13
- package/src/models/streamEventTypePatch.ts +6 -6
- package/src/models/streamIn.ts +3 -3
- package/src/models/streamOut.ts +10 -10
- package/src/models/streamPatch.ts +3 -3
- package/src/models/streamPortalAccessIn.ts +4 -4
- package/src/models/streamSinkIn.ts +96 -84
- package/src/models/streamSinkOut.ts +133 -118
- package/src/models/streamSinkPatch.ts +95 -92
- package/src/request.test.ts +34 -0
- package/src/request.ts +61 -3
- package/dist/HttpErrors.d.ts +0 -60
- package/dist/HttpErrors.js +0 -70
- package/dist/HttpErrors.js.map +0 -1
- package/dist/api/application.d.ts +0 -28
- package/dist/api/application.js +0 -83
- package/dist/api/application.js.map +0 -1
- package/dist/api/authentication.d.ts +0 -46
- package/dist/api/authentication.js +0 -102
- package/dist/api/authentication.js.map +0 -1
- package/dist/api/backgroundTask.d.ts +0 -20
- package/dist/api/backgroundTask.js +0 -45
- package/dist/api/backgroundTask.js.map +0 -1
- package/dist/api/connector.d.ts +0 -27
- package/dist/api/connector.js +0 -75
- package/dist/api/connector.js.map +0 -1
- package/dist/api/endpoint.d.ts +0 -75
- package/dist/api/endpoint.js +0 -224
- package/dist/api/endpoint.js.map +0 -1
- package/dist/api/environment.d.ts +0 -15
- package/dist/api/environment.js +0 -37
- package/dist/api/environment.js.map +0 -1
- package/dist/api/eventType.d.ts +0 -36
- package/dist/api/eventType.js +0 -89
- package/dist/api/eventType.js.map +0 -1
- package/dist/api/health.d.ts +0 -6
- package/dist/api/health.js +0 -26
- package/dist/api/health.js.map +0 -1
- package/dist/api/ingest.d.ts +0 -15
- package/dist/api/ingest.js +0 -39
- package/dist/api/ingest.js.map +0 -1
- package/dist/api/ingestEndpoint.d.ts +0 -38
- package/dist/api/ingestEndpoint.js +0 -128
- package/dist/api/ingestEndpoint.js.map +0 -1
- package/dist/api/ingestSource.d.ts +0 -27
- package/dist/api/ingestSource.js +0 -73
- package/dist/api/ingestSource.js.map +0 -1
- package/dist/api/integration.d.ts +0 -29
- package/dist/api/integration.js +0 -88
- package/dist/api/integration.js.map +0 -1
- package/dist/api/message.d.ts +0 -43
- package/dist/api/message.js +0 -112
- package/dist/api/message.js.map +0 -1
- package/dist/api/messageAttempt.d.ts +0 -69
- package/dist/api/messageAttempt.js +0 -136
- package/dist/api/messageAttempt.js.map +0 -1
- package/dist/api/messagePoller.d.ts +0 -25
- package/dist/api/messagePoller.js +0 -62
- package/dist/api/messagePoller.js.map +0 -1
- package/dist/api/operationalWebhook.d.ts +0 -7
- package/dist/api/operationalWebhook.js +0 -14
- package/dist/api/operationalWebhook.js.map +0 -1
- package/dist/api/operationalWebhookEndpoint.d.ts +0 -34
- package/dist/api/operationalWebhookEndpoint.js +0 -100
- package/dist/api/operationalWebhookEndpoint.js.map +0 -1
- package/dist/api/statistics.d.ts +0 -13
- package/dist/api/statistics.js +0 -37
- package/dist/api/statistics.js.map +0 -1
- package/dist/api/streaming.d.ts +0 -19
- package/dist/api/streaming.js +0 -64
- package/dist/api/streaming.js.map +0 -1
- package/dist/api/streamingEventType.d.ts +0 -28
- package/dist/api/streamingEventType.js +0 -77
- package/dist/api/streamingEventType.js.map +0 -1
- package/dist/api/streamingEvents.d.ts +0 -18
- package/dist/api/streamingEvents.js +0 -45
- package/dist/api/streamingEvents.js.map +0 -1
- package/dist/api/streamingSink.d.ts +0 -34
- package/dist/api/streamingSink.js +0 -110
- package/dist/api/streamingSink.js.map +0 -1
- package/dist/api/streamingStream.d.ts +0 -24
- package/dist/api/streamingStream.js +0 -73
- package/dist/api/streamingStream.js.map +0 -1
- package/dist/api_internal/endpoint.d.ts +0 -9
- package/dist/api_internal/endpoint.js +0 -34
- package/dist/api_internal/endpoint.js.map +0 -1
- package/dist/api_internal/endpointAutoConfig.d.ts +0 -8
- package/dist/api_internal/endpointAutoConfig.js +0 -31
- package/dist/api_internal/endpointAutoConfig.js.map +0 -1
- package/dist/api_internal/index.d.ts +0 -5
- package/dist/api_internal/index.js +0 -11
- package/dist/api_internal/index.js.map +0 -1
- package/dist/api_internal/message.d.ts +0 -9
- package/dist/api_internal/message.js +0 -26
- package/dist/api_internal/message.js.map +0 -1
- package/dist/api_internal/messagePollerv2.d.ts +0 -18
- package/dist/api_internal/messagePollerv2.js +0 -47
- package/dist/api_internal/messagePollerv2.js.map +0 -1
- package/dist/autoconfig.d.ts +0 -27
- package/dist/autoconfig.js +0 -79
- package/dist/autoconfig.js.map +0 -1
- package/dist/autoconfigConsumer.d.ts +0 -14
- package/dist/autoconfigConsumer.js +0 -35
- package/dist/autoconfigConsumer.js.map +0 -1
- package/dist/index.d.ts +0 -62
- package/dist/index.js +0 -138
- package/dist/index.js.map +0 -1
- package/dist/models/adobeSignConfig.d.ts +0 -7
- package/dist/models/adobeSignConfig.js +0 -16
- package/dist/models/adobeSignConfig.js.map +0 -1
- package/dist/models/adobeSignConfigOut.d.ts +0 -6
- package/dist/models/adobeSignConfigOut.js +0 -12
- package/dist/models/adobeSignConfigOut.js.map +0 -1
- package/dist/models/aggregateEventTypesOut.d.ts +0 -12
- package/dist/models/aggregateEventTypesOut.js +0 -24
- package/dist/models/aggregateEventTypesOut.js.map +0 -1
- package/dist/models/airwallexConfig.d.ts +0 -7
- package/dist/models/airwallexConfig.js +0 -16
- package/dist/models/airwallexConfig.js.map +0 -1
- package/dist/models/airwallexConfigOut.d.ts +0 -6
- package/dist/models/airwallexConfigOut.js +0 -12
- package/dist/models/airwallexConfigOut.js.map +0 -1
- package/dist/models/amazonS3PatchConfig.d.ts +0 -11
- package/dist/models/amazonS3PatchConfig.js +0 -24
- package/dist/models/amazonS3PatchConfig.js.map +0 -1
- package/dist/models/apiTokenOut.d.ts +0 -12
- package/dist/models/apiTokenOut.js +0 -26
- package/dist/models/apiTokenOut.js.map +0 -1
- package/dist/models/appPortalAccessIn.d.ts +0 -14
- package/dist/models/appPortalAccessIn.js +0 -34
- package/dist/models/appPortalAccessIn.js.map +0 -1
- package/dist/models/appPortalAccessOut.d.ts +0 -8
- package/dist/models/appPortalAccessOut.js +0 -18
- package/dist/models/appPortalAccessOut.js.map +0 -1
- package/dist/models/appPortalCapability.d.ts +0 -12
- package/dist/models/appPortalCapability.js +0 -21
- package/dist/models/appPortalCapability.js.map +0 -1
- package/dist/models/appUsageStatsIn.d.ts +0 -9
- package/dist/models/appUsageStatsIn.js +0 -20
- package/dist/models/appUsageStatsIn.js.map +0 -1
- package/dist/models/appUsageStatsOut.d.ts +0 -13
- package/dist/models/appUsageStatsOut.js +0 -26
- package/dist/models/appUsageStatsOut.js.map +0 -1
- package/dist/models/applicationIn.d.ts +0 -13
- package/dist/models/applicationIn.js +0 -24
- package/dist/models/applicationIn.js.map +0 -1
- package/dist/models/applicationOut.d.ts +0 -16
- package/dist/models/applicationOut.js +0 -30
- package/dist/models/applicationOut.js.map +0 -1
- package/dist/models/applicationPatch.d.ts +0 -13
- package/dist/models/applicationPatch.js +0 -24
- package/dist/models/applicationPatch.js.map +0 -1
- package/dist/models/applicationTokenExpireIn.d.ts +0 -8
- package/dist/models/applicationTokenExpireIn.js +0 -18
- package/dist/models/applicationTokenExpireIn.js.map +0 -1
- package/dist/models/autoConfigSinkType.d.ts +0 -18
- package/dist/models/autoConfigSinkType.js +0 -40
- package/dist/models/autoConfigSinkType.js.map +0 -1
- package/dist/models/azureBlobStorageConfig.d.ts +0 -9
- package/dist/models/azureBlobStorageConfig.js +0 -20
- package/dist/models/azureBlobStorageConfig.js.map +0 -1
- package/dist/models/azureBlobStoragePatchConfig.d.ts +0 -9
- package/dist/models/azureBlobStoragePatchConfig.js +0 -20
- package/dist/models/azureBlobStoragePatchConfig.js.map +0 -1
- package/dist/models/backgroundTaskFinishedEvent.d.ts +0 -9
- package/dist/models/backgroundTaskFinishedEvent.js +0 -19
- package/dist/models/backgroundTaskFinishedEvent.js.map +0 -1
- package/dist/models/backgroundTaskFinishedEvent2.d.ts +0 -12
- package/dist/models/backgroundTaskFinishedEvent2.js +0 -24
- package/dist/models/backgroundTaskFinishedEvent2.js.map +0 -1
- package/dist/models/backgroundTaskOut.d.ts +0 -13
- package/dist/models/backgroundTaskOut.js +0 -26
- package/dist/models/backgroundTaskOut.js.map +0 -1
- package/dist/models/backgroundTaskStatus.d.ts +0 -9
- package/dist/models/backgroundTaskStatus.js +0 -18
- package/dist/models/backgroundTaskStatus.js.map +0 -1
- package/dist/models/backgroundTaskType.d.ts +0 -14
- package/dist/models/backgroundTaskType.js +0 -23
- package/dist/models/backgroundTaskType.js.map +0 -1
- package/dist/models/bigQueryConfig.d.ts +0 -10
- package/dist/models/bigQueryConfig.js +0 -22
- package/dist/models/bigQueryConfig.js.map +0 -1
- package/dist/models/bigQueryPatchConfig.d.ts +0 -10
- package/dist/models/bigQueryPatchConfig.js +0 -22
- package/dist/models/bigQueryPatchConfig.js.map +0 -1
- package/dist/models/bulkReplayIn.d.ts +0 -15
- package/dist/models/bulkReplayIn.js +0 -38
- package/dist/models/bulkReplayIn.js.map +0 -1
- package/dist/models/checkbookConfig.d.ts +0 -7
- package/dist/models/checkbookConfig.js +0 -16
- package/dist/models/checkbookConfig.js.map +0 -1
- package/dist/models/checkbookConfigOut.d.ts +0 -6
- package/dist/models/checkbookConfigOut.js +0 -12
- package/dist/models/checkbookConfigOut.js.map +0 -1
- package/dist/models/clickhouseConfig.d.ts +0 -11
- package/dist/models/clickhouseConfig.js +0 -24
- package/dist/models/clickhouseConfig.js.map +0 -1
- package/dist/models/clickhousePatchConfig.d.ts +0 -11
- package/dist/models/clickhousePatchConfig.js +0 -24
- package/dist/models/clickhousePatchConfig.js.map +0 -1
- package/dist/models/connectorIn.d.ts +0 -18
- package/dist/models/connectorIn.js +0 -42
- package/dist/models/connectorIn.js.map +0 -1
- package/dist/models/connectorKind.d.ts +0 -24
- package/dist/models/connectorKind.js +0 -33
- package/dist/models/connectorKind.js.map +0 -1
- package/dist/models/connectorOut.d.ts +0 -23
- package/dist/models/connectorOut.js +0 -46
- package/dist/models/connectorOut.js.map +0 -1
- package/dist/models/connectorPatch.d.ts +0 -15
- package/dist/models/connectorPatch.js +0 -33
- package/dist/models/connectorPatch.js.map +0 -1
- package/dist/models/connectorProduct.d.ts +0 -8
- package/dist/models/connectorProduct.js +0 -17
- package/dist/models/connectorProduct.js.map +0 -1
- package/dist/models/connectorUpdate.d.ts +0 -15
- package/dist/models/connectorUpdate.js +0 -33
- package/dist/models/connectorUpdate.js.map +0 -1
- package/dist/models/createStreamEventsIn.d.ts +0 -10
- package/dist/models/createStreamEventsIn.js +0 -22
- package/dist/models/createStreamEventsIn.js.map +0 -1
- package/dist/models/createStreamEventsOut.d.ts +0 -6
- package/dist/models/createStreamEventsOut.js +0 -12
- package/dist/models/createStreamEventsOut.js.map +0 -1
- package/dist/models/cronConfig.d.ts +0 -9
- package/dist/models/cronConfig.js +0 -20
- package/dist/models/cronConfig.js.map +0 -1
- package/dist/models/dashboardAccessOut.d.ts +0 -8
- package/dist/models/dashboardAccessOut.js +0 -18
- package/dist/models/dashboardAccessOut.js.map +0 -1
- package/dist/models/docusignConfig.d.ts +0 -7
- package/dist/models/docusignConfig.js +0 -16
- package/dist/models/docusignConfig.js.map +0 -1
- package/dist/models/docusignConfigOut.d.ts +0 -6
- package/dist/models/docusignConfigOut.js +0 -12
- package/dist/models/docusignConfigOut.js.map +0 -1
- package/dist/models/easypostConfig.d.ts +0 -7
- package/dist/models/easypostConfig.js +0 -16
- package/dist/models/easypostConfig.js.map +0 -1
- package/dist/models/easypostConfigOut.d.ts +0 -6
- package/dist/models/easypostConfigOut.js +0 -12
- package/dist/models/easypostConfigOut.js.map +0 -1
- package/dist/models/emptyResponse.d.ts +0 -6
- package/dist/models/emptyResponse.js +0 -12
- package/dist/models/emptyResponse.js.map +0 -1
- package/dist/models/endpointCreatedEvent.d.ts +0 -9
- package/dist/models/endpointCreatedEvent.js +0 -19
- package/dist/models/endpointCreatedEvent.js.map +0 -1
- package/dist/models/endpointCreatedEventData.d.ts +0 -10
- package/dist/models/endpointCreatedEventData.js +0 -22
- package/dist/models/endpointCreatedEventData.js.map +0 -1
- package/dist/models/endpointDeletedEvent.d.ts +0 -9
- package/dist/models/endpointDeletedEvent.js +0 -19
- package/dist/models/endpointDeletedEvent.js.map +0 -1
- package/dist/models/endpointDeletedEventData.d.ts +0 -10
- package/dist/models/endpointDeletedEventData.js +0 -22
- package/dist/models/endpointDeletedEventData.js.map +0 -1
- package/dist/models/endpointDisabledEvent.d.ts +0 -9
- package/dist/models/endpointDisabledEvent.js +0 -19
- package/dist/models/endpointDisabledEvent.js.map +0 -1
- package/dist/models/endpointDisabledEventData.d.ts +0 -13
- package/dist/models/endpointDisabledEventData.js +0 -31
- package/dist/models/endpointDisabledEventData.js.map +0 -1
- package/dist/models/endpointDisabledTrigger.d.ts +0 -8
- package/dist/models/endpointDisabledTrigger.js +0 -17
- package/dist/models/endpointDisabledTrigger.js.map +0 -1
- package/dist/models/endpointEnabledEvent.d.ts +0 -9
- package/dist/models/endpointEnabledEvent.js +0 -19
- package/dist/models/endpointEnabledEvent.js.map +0 -1
- package/dist/models/endpointEnabledEventData.d.ts +0 -10
- package/dist/models/endpointEnabledEventData.js +0 -22
- package/dist/models/endpointEnabledEventData.js.map +0 -1
- package/dist/models/endpointHeadersIn.d.ts +0 -9
- package/dist/models/endpointHeadersIn.js +0 -16
- package/dist/models/endpointHeadersIn.js.map +0 -1
- package/dist/models/endpointHeadersOut.d.ts +0 -10
- package/dist/models/endpointHeadersOut.js +0 -18
- package/dist/models/endpointHeadersOut.js.map +0 -1
- package/dist/models/endpointHeadersPatchIn.d.ts +0 -10
- package/dist/models/endpointHeadersPatchIn.js +0 -18
- package/dist/models/endpointHeadersPatchIn.js.map +0 -1
- package/dist/models/endpointIn.d.ts +0 -22
- package/dist/models/endpointIn.js +0 -38
- package/dist/models/endpointIn.js.map +0 -1
- package/dist/models/endpointMessageOut.d.ts +0 -19
- package/dist/models/endpointMessageOut.js +0 -38
- package/dist/models/endpointMessageOut.js.map +0 -1
- package/dist/models/endpointOut.d.ts +0 -21
- package/dist/models/endpointOut.js +0 -40
- package/dist/models/endpointOut.js.map +0 -1
- package/dist/models/endpointPatch.d.ts +0 -19
- package/dist/models/endpointPatch.js +0 -36
- package/dist/models/endpointPatch.js.map +0 -1
- package/dist/models/endpointSecretOut.d.ts +0 -7
- package/dist/models/endpointSecretOut.js +0 -16
- package/dist/models/endpointSecretOut.js.map +0 -1
- package/dist/models/endpointSecretRotateIn.d.ts +0 -8
- package/dist/models/endpointSecretRotateIn.js +0 -18
- package/dist/models/endpointSecretRotateIn.js.map +0 -1
- package/dist/models/endpointStats.d.ts +0 -11
- package/dist/models/endpointStats.js +0 -24
- package/dist/models/endpointStats.js.map +0 -1
- package/dist/models/endpointTransformationIn.d.ts +0 -8
- package/dist/models/endpointTransformationIn.js +0 -18
- package/dist/models/endpointTransformationIn.js.map +0 -1
- package/dist/models/endpointTransformationOut.d.ts +0 -12
- package/dist/models/endpointTransformationOut.js +0 -22
- package/dist/models/endpointTransformationOut.js.map +0 -1
- package/dist/models/endpointTransformationPatch.d.ts +0 -11
- package/dist/models/endpointTransformationPatch.js +0 -20
- package/dist/models/endpointTransformationPatch.js.map +0 -1
- package/dist/models/endpointUpdate.d.ts +0 -18
- package/dist/models/endpointUpdate.js +0 -34
- package/dist/models/endpointUpdate.js.map +0 -1
- package/dist/models/endpointUpdatedEvent.d.ts +0 -9
- package/dist/models/endpointUpdatedEvent.js +0 -19
- package/dist/models/endpointUpdatedEvent.js.map +0 -1
- package/dist/models/endpointUpdatedEventData.d.ts +0 -10
- package/dist/models/endpointUpdatedEventData.js +0 -22
- package/dist/models/endpointUpdatedEventData.js.map +0 -1
- package/dist/models/environmentIn.d.ts +0 -11
- package/dist/models/environmentIn.js +0 -24
- package/dist/models/environmentIn.js.map +0 -1
- package/dist/models/environmentOut.d.ts +0 -13
- package/dist/models/environmentOut.js +0 -26
- package/dist/models/environmentOut.js.map +0 -1
- package/dist/models/eventBridgeConfig.d.ts +0 -11
- package/dist/models/eventBridgeConfig.js +0 -24
- package/dist/models/eventBridgeConfig.js.map +0 -1
- package/dist/models/eventBridgePatchConfig.d.ts +0 -11
- package/dist/models/eventBridgePatchConfig.js +0 -24
- package/dist/models/eventBridgePatchConfig.js.map +0 -1
- package/dist/models/eventExampleIn.d.ts +0 -8
- package/dist/models/eventExampleIn.js +0 -18
- package/dist/models/eventExampleIn.js.map +0 -1
- package/dist/models/eventIn.d.ts +0 -8
- package/dist/models/eventIn.js +0 -18
- package/dist/models/eventIn.js.map +0 -1
- package/dist/models/eventOut.d.ts +0 -9
- package/dist/models/eventOut.js +0 -20
- package/dist/models/eventOut.js.map +0 -1
- package/dist/models/eventStreamOut.d.ts +0 -10
- package/dist/models/eventStreamOut.js +0 -21
- package/dist/models/eventStreamOut.js.map +0 -1
- package/dist/models/eventTypeFromOpenApi.d.ts +0 -13
- package/dist/models/eventTypeFromOpenApi.js +0 -28
- package/dist/models/eventTypeFromOpenApi.js.map +0 -1
- package/dist/models/eventTypeImportOpenApiIn.d.ts +0 -10
- package/dist/models/eventTypeImportOpenApiIn.js +0 -22
- package/dist/models/eventTypeImportOpenApiIn.js.map +0 -1
- package/dist/models/eventTypeImportOpenApiOut.d.ts +0 -8
- package/dist/models/eventTypeImportOpenApiOut.js +0 -17
- package/dist/models/eventTypeImportOpenApiOut.js.map +0 -1
- package/dist/models/eventTypeImportOpenApiOutData.d.ts +0 -9
- package/dist/models/eventTypeImportOpenApiOutData.js +0 -21
- package/dist/models/eventTypeImportOpenApiOutData.js.map +0 -1
- package/dist/models/eventTypeIn.d.ts +0 -14
- package/dist/models/eventTypeIn.js +0 -30
- package/dist/models/eventTypeIn.js.map +0 -1
- package/dist/models/eventTypeOut.d.ts +0 -16
- package/dist/models/eventTypeOut.js +0 -34
- package/dist/models/eventTypeOut.js.map +0 -1
- package/dist/models/eventTypePatch.d.ts +0 -13
- package/dist/models/eventTypePatch.js +0 -28
- package/dist/models/eventTypePatch.js.map +0 -1
- package/dist/models/eventTypeUpdate.d.ts +0 -13
- package/dist/models/eventTypeUpdate.js +0 -28
- package/dist/models/eventTypeUpdate.js.map +0 -1
- package/dist/models/expungeAllContentsOut.d.ts +0 -12
- package/dist/models/expungeAllContentsOut.js +0 -24
- package/dist/models/expungeAllContentsOut.js.map +0 -1
- package/dist/models/githubConfig.d.ts +0 -7
- package/dist/models/githubConfig.js +0 -16
- package/dist/models/githubConfig.js.map +0 -1
- package/dist/models/githubConfigOut.d.ts +0 -6
- package/dist/models/githubConfigOut.js +0 -12
- package/dist/models/githubConfigOut.js.map +0 -1
- package/dist/models/googleCloudPubSubConfig.d.ts +0 -9
- package/dist/models/googleCloudPubSubConfig.js +0 -20
- package/dist/models/googleCloudPubSubConfig.js.map +0 -1
- package/dist/models/googleCloudPubSubPatchConfig.d.ts +0 -9
- package/dist/models/googleCloudPubSubPatchConfig.js +0 -20
- package/dist/models/googleCloudPubSubPatchConfig.js.map +0 -1
- package/dist/models/googleCloudStorageConfig.d.ts +0 -8
- package/dist/models/googleCloudStorageConfig.js +0 -18
- package/dist/models/googleCloudStorageConfig.js.map +0 -1
- package/dist/models/googleCloudStoragePatchConfig.d.ts +0 -8
- package/dist/models/googleCloudStoragePatchConfig.js +0 -18
- package/dist/models/googleCloudStoragePatchConfig.js.map +0 -1
- package/dist/models/httpAttemptTimes.d.ts +0 -8
- package/dist/models/httpAttemptTimes.js +0 -18
- package/dist/models/httpAttemptTimes.js.map +0 -1
- package/dist/models/httpPatchConfig.d.ts +0 -7
- package/dist/models/httpPatchConfig.js +0 -16
- package/dist/models/httpPatchConfig.js.map +0 -1
- package/dist/models/httpSinkHeadersPatchIn.d.ts +0 -9
- package/dist/models/httpSinkHeadersPatchIn.js +0 -16
- package/dist/models/httpSinkHeadersPatchIn.js.map +0 -1
- package/dist/models/hubspotConfig.d.ts +0 -7
- package/dist/models/hubspotConfig.js +0 -16
- package/dist/models/hubspotConfig.js.map +0 -1
- package/dist/models/hubspotConfigOut.d.ts +0 -6
- package/dist/models/hubspotConfigOut.js +0 -12
- package/dist/models/hubspotConfigOut.js.map +0 -1
- package/dist/models/index.d.ts +0 -241
- package/dist/models/index.js +0 -30
- package/dist/models/index.js.map +0 -1
- package/dist/models/ingestEndpointDisabledEvent.d.ts +0 -9
- package/dist/models/ingestEndpointDisabledEvent.js +0 -19
- package/dist/models/ingestEndpointDisabledEvent.js.map +0 -1
- package/dist/models/ingestEndpointDisabledEventData.d.ts +0 -12
- package/dist/models/ingestEndpointDisabledEventData.js +0 -29
- package/dist/models/ingestEndpointDisabledEventData.js.map +0 -1
- package/dist/models/ingestEndpointHeadersIn.d.ts +0 -9
- package/dist/models/ingestEndpointHeadersIn.js +0 -16
- package/dist/models/ingestEndpointHeadersIn.js.map +0 -1
- package/dist/models/ingestEndpointHeadersOut.d.ts +0 -10
- package/dist/models/ingestEndpointHeadersOut.js +0 -18
- package/dist/models/ingestEndpointHeadersOut.js.map +0 -1
- package/dist/models/ingestEndpointIn.d.ts +0 -16
- package/dist/models/ingestEndpointIn.js +0 -30
- package/dist/models/ingestEndpointIn.js.map +0 -1
- package/dist/models/ingestEndpointOut.d.ts +0 -18
- package/dist/models/ingestEndpointOut.js +0 -34
- package/dist/models/ingestEndpointOut.js.map +0 -1
- package/dist/models/ingestEndpointSecretIn.d.ts +0 -7
- package/dist/models/ingestEndpointSecretIn.js +0 -16
- package/dist/models/ingestEndpointSecretIn.js.map +0 -1
- package/dist/models/ingestEndpointSecretOut.d.ts +0 -7
- package/dist/models/ingestEndpointSecretOut.js +0 -16
- package/dist/models/ingestEndpointSecretOut.js.map +0 -1
- package/dist/models/ingestEndpointTransformationOut.d.ts +0 -8
- package/dist/models/ingestEndpointTransformationOut.js +0 -18
- package/dist/models/ingestEndpointTransformationOut.js.map +0 -1
- package/dist/models/ingestEndpointTransformationPatch.d.ts +0 -8
- package/dist/models/ingestEndpointTransformationPatch.js +0 -18
- package/dist/models/ingestEndpointTransformationPatch.js.map +0 -1
- package/dist/models/ingestEndpointUpdate.d.ts +0 -15
- package/dist/models/ingestEndpointUpdate.js +0 -28
- package/dist/models/ingestEndpointUpdate.js.map +0 -1
- package/dist/models/ingestMessageAttemptExhaustedEvent.d.ts +0 -9
- package/dist/models/ingestMessageAttemptExhaustedEvent.js +0 -19
- package/dist/models/ingestMessageAttemptExhaustedEvent.js.map +0 -1
- package/dist/models/ingestMessageAttemptExhaustedEventData.d.ts +0 -12
- package/dist/models/ingestMessageAttemptExhaustedEventData.js +0 -25
- package/dist/models/ingestMessageAttemptExhaustedEventData.js.map +0 -1
- package/dist/models/ingestMessageAttemptFailingEvent.d.ts +0 -9
- package/dist/models/ingestMessageAttemptFailingEvent.js +0 -19
- package/dist/models/ingestMessageAttemptFailingEvent.js.map +0 -1
- package/dist/models/ingestMessageAttemptFailingEventData.d.ts +0 -12
- package/dist/models/ingestMessageAttemptFailingEventData.js +0 -25
- package/dist/models/ingestMessageAttemptFailingEventData.js.map +0 -1
- package/dist/models/ingestMessageAttemptRecoveredEvent.d.ts +0 -9
- package/dist/models/ingestMessageAttemptRecoveredEvent.js +0 -19
- package/dist/models/ingestMessageAttemptRecoveredEvent.js.map +0 -1
- package/dist/models/ingestMessageAttemptRecoveredEventData.d.ts +0 -12
- package/dist/models/ingestMessageAttemptRecoveredEventData.js +0 -25
- package/dist/models/ingestMessageAttemptRecoveredEventData.js.map +0 -1
- package/dist/models/ingestSourceConsumerPortalAccessIn.d.ts +0 -8
- package/dist/models/ingestSourceConsumerPortalAccessIn.js +0 -18
- package/dist/models/ingestSourceConsumerPortalAccessIn.js.map +0 -1
- package/dist/models/ingestSourceIn.d.ts +0 -213
- package/dist/models/ingestSourceIn.js +0 -275
- package/dist/models/ingestSourceIn.js.map +0 -1
- package/dist/models/ingestSourceOut.d.ts +0 -217
- package/dist/models/ingestSourceOut.js +0 -283
- package/dist/models/ingestSourceOut.js.map +0 -1
- package/dist/models/integrationIn.d.ts +0 -8
- package/dist/models/integrationIn.js +0 -18
- package/dist/models/integrationIn.js.map +0 -1
- package/dist/models/integrationKeyOut.d.ts +0 -7
- package/dist/models/integrationKeyOut.js +0 -16
- package/dist/models/integrationKeyOut.js.map +0 -1
- package/dist/models/integrationOut.d.ts +0 -11
- package/dist/models/integrationOut.js +0 -24
- package/dist/models/integrationOut.js.map +0 -1
- package/dist/models/integrationUpdate.d.ts +0 -8
- package/dist/models/integrationUpdate.js +0 -18
- package/dist/models/integrationUpdate.js.map +0 -1
- package/dist/models/listResponseApplicationOut.d.ts +0 -11
- package/dist/models/listResponseApplicationOut.js +0 -23
- package/dist/models/listResponseApplicationOut.js.map +0 -1
- package/dist/models/listResponseBackgroundTaskOut.d.ts +0 -11
- package/dist/models/listResponseBackgroundTaskOut.js +0 -23
- package/dist/models/listResponseBackgroundTaskOut.js.map +0 -1
- package/dist/models/listResponseConnectorOut.d.ts +0 -11
- package/dist/models/listResponseConnectorOut.js +0 -23
- package/dist/models/listResponseConnectorOut.js.map +0 -1
- package/dist/models/listResponseEndpointMessageOut.d.ts +0 -11
- package/dist/models/listResponseEndpointMessageOut.js +0 -23
- package/dist/models/listResponseEndpointMessageOut.js.map +0 -1
- package/dist/models/listResponseEndpointOut.d.ts +0 -11
- package/dist/models/listResponseEndpointOut.js +0 -23
- package/dist/models/listResponseEndpointOut.js.map +0 -1
- package/dist/models/listResponseEventTypeOut.d.ts +0 -11
- package/dist/models/listResponseEventTypeOut.js +0 -23
- package/dist/models/listResponseEventTypeOut.js.map +0 -1
- package/dist/models/listResponseIngestEndpointOut.d.ts +0 -11
- package/dist/models/listResponseIngestEndpointOut.js +0 -23
- package/dist/models/listResponseIngestEndpointOut.js.map +0 -1
- package/dist/models/listResponseIngestSourceOut.d.ts +0 -11
- package/dist/models/listResponseIngestSourceOut.js +0 -23
- package/dist/models/listResponseIngestSourceOut.js.map +0 -1
- package/dist/models/listResponseIntegrationOut.d.ts +0 -11
- package/dist/models/listResponseIntegrationOut.js +0 -23
- package/dist/models/listResponseIntegrationOut.js.map +0 -1
- package/dist/models/listResponseMessageAttemptOut.d.ts +0 -11
- package/dist/models/listResponseMessageAttemptOut.js +0 -23
- package/dist/models/listResponseMessageAttemptOut.js.map +0 -1
- package/dist/models/listResponseMessageEndpointOut.d.ts +0 -11
- package/dist/models/listResponseMessageEndpointOut.js +0 -23
- package/dist/models/listResponseMessageEndpointOut.js.map +0 -1
- package/dist/models/listResponseMessageOut.d.ts +0 -11
- package/dist/models/listResponseMessageOut.js +0 -23
- package/dist/models/listResponseMessageOut.js.map +0 -1
- package/dist/models/listResponseOperationalWebhookEndpointOut.d.ts +0 -11
- package/dist/models/listResponseOperationalWebhookEndpointOut.js +0 -23
- package/dist/models/listResponseOperationalWebhookEndpointOut.js.map +0 -1
- package/dist/models/listResponseStreamEventTypeOut.d.ts +0 -11
- package/dist/models/listResponseStreamEventTypeOut.js +0 -23
- package/dist/models/listResponseStreamEventTypeOut.js.map +0 -1
- package/dist/models/listResponseStreamOut.d.ts +0 -11
- package/dist/models/listResponseStreamOut.js +0 -23
- package/dist/models/listResponseStreamOut.js.map +0 -1
- package/dist/models/listResponseStreamSinkOut.d.ts +0 -11
- package/dist/models/listResponseStreamSinkOut.js +0 -23
- package/dist/models/listResponseStreamSinkOut.js.map +0 -1
- package/dist/models/messageAttemptExhaustedEvent.d.ts +0 -9
- package/dist/models/messageAttemptExhaustedEvent.js +0 -19
- package/dist/models/messageAttemptExhaustedEvent.js.map +0 -1
- package/dist/models/messageAttemptExhaustedEventData.d.ts +0 -13
- package/dist/models/messageAttemptExhaustedEventData.js +0 -27
- package/dist/models/messageAttemptExhaustedEventData.js.map +0 -1
- package/dist/models/messageAttemptFailedData.d.ts +0 -9
- package/dist/models/messageAttemptFailedData.js +0 -20
- package/dist/models/messageAttemptFailedData.js.map +0 -1
- package/dist/models/messageAttemptFailingEvent.d.ts +0 -9
- package/dist/models/messageAttemptFailingEvent.js +0 -19
- package/dist/models/messageAttemptFailingEvent.js.map +0 -1
- package/dist/models/messageAttemptFailingEventData.d.ts +0 -13
- package/dist/models/messageAttemptFailingEventData.js +0 -27
- package/dist/models/messageAttemptFailingEventData.js.map +0 -1
- package/dist/models/messageAttemptLog.d.ts +0 -23
- package/dist/models/messageAttemptLog.js +0 -50
- package/dist/models/messageAttemptLog.js.map +0 -1
- package/dist/models/messageAttemptLogEvent.d.ts +0 -9
- package/dist/models/messageAttemptLogEvent.js +0 -19
- package/dist/models/messageAttemptLogEvent.js.map +0 -1
- package/dist/models/messageAttemptOut.d.ts +0 -22
- package/dist/models/messageAttemptOut.js +0 -44
- package/dist/models/messageAttemptOut.js.map +0 -1
- package/dist/models/messageAttemptRecoveredEvent.d.ts +0 -9
- package/dist/models/messageAttemptRecoveredEvent.js +0 -19
- package/dist/models/messageAttemptRecoveredEvent.js.map +0 -1
- package/dist/models/messageAttemptRecoveredEventData.d.ts +0 -13
- package/dist/models/messageAttemptRecoveredEventData.js +0 -27
- package/dist/models/messageAttemptRecoveredEventData.js.map +0 -1
- package/dist/models/messageAttemptTriggerType.d.ts +0 -8
- package/dist/models/messageAttemptTriggerType.js +0 -17
- package/dist/models/messageAttemptTriggerType.js.map +0 -1
- package/dist/models/messageEndpointOut.d.ts +0 -23
- package/dist/models/messageEndpointOut.js +0 -46
- package/dist/models/messageEndpointOut.js.map +0 -1
- package/dist/models/messageIn.d.ts +0 -17
- package/dist/models/messageIn.js +0 -39
- package/dist/models/messageIn.js.map +0 -1
- package/dist/models/messageOut.d.ts +0 -14
- package/dist/models/messageOut.js +0 -30
- package/dist/models/messageOut.js.map +0 -1
- package/dist/models/messagePrecheckIn.d.ts +0 -8
- package/dist/models/messagePrecheckIn.js +0 -18
- package/dist/models/messagePrecheckIn.js.map +0 -1
- package/dist/models/messagePrecheckOut.d.ts +0 -7
- package/dist/models/messagePrecheckOut.js +0 -16
- package/dist/models/messagePrecheckOut.js.map +0 -1
- package/dist/models/messageStatus.d.ts +0 -11
- package/dist/models/messageStatus.js +0 -20
- package/dist/models/messageStatus.js.map +0 -1
- package/dist/models/messageStatusText.d.ts +0 -11
- package/dist/models/messageStatusText.js +0 -20
- package/dist/models/messageStatusText.js.map +0 -1
- package/dist/models/metaConfig.d.ts +0 -8
- package/dist/models/metaConfig.js +0 -18
- package/dist/models/metaConfig.js.map +0 -1
- package/dist/models/metaConfigOut.d.ts +0 -6
- package/dist/models/metaConfigOut.js +0 -12
- package/dist/models/metaConfigOut.js.map +0 -1
- package/dist/models/nangoConfig.d.ts +0 -7
- package/dist/models/nangoConfig.js +0 -16
- package/dist/models/nangoConfig.js.map +0 -1
- package/dist/models/nangoConfigOut.d.ts +0 -6
- package/dist/models/nangoConfigOut.js +0 -12
- package/dist/models/nangoConfigOut.js.map +0 -1
- package/dist/models/openClawConfig.d.ts +0 -7
- package/dist/models/openClawConfig.js +0 -16
- package/dist/models/openClawConfig.js.map +0 -1
- package/dist/models/openClawConfigOut.d.ts +0 -6
- package/dist/models/openClawConfigOut.js +0 -12
- package/dist/models/openClawConfigOut.js.map +0 -1
- package/dist/models/operationalWebhookEndpointHeadersIn.d.ts +0 -9
- package/dist/models/operationalWebhookEndpointHeadersIn.js +0 -16
- package/dist/models/operationalWebhookEndpointHeadersIn.js.map +0 -1
- package/dist/models/operationalWebhookEndpointHeadersOut.d.ts +0 -10
- package/dist/models/operationalWebhookEndpointHeadersOut.js +0 -18
- package/dist/models/operationalWebhookEndpointHeadersOut.js.map +0 -1
- package/dist/models/operationalWebhookEndpointIn.d.ts +0 -17
- package/dist/models/operationalWebhookEndpointIn.js +0 -32
- package/dist/models/operationalWebhookEndpointIn.js.map +0 -1
- package/dist/models/operationalWebhookEndpointOut.d.ts +0 -19
- package/dist/models/operationalWebhookEndpointOut.js +0 -36
- package/dist/models/operationalWebhookEndpointOut.js.map +0 -1
- package/dist/models/operationalWebhookEndpointSecretIn.d.ts +0 -7
- package/dist/models/operationalWebhookEndpointSecretIn.js +0 -16
- package/dist/models/operationalWebhookEndpointSecretIn.js.map +0 -1
- package/dist/models/operationalWebhookEndpointSecretOut.d.ts +0 -7
- package/dist/models/operationalWebhookEndpointSecretOut.js +0 -16
- package/dist/models/operationalWebhookEndpointSecretOut.js.map +0 -1
- package/dist/models/operationalWebhookEndpointUpdate.d.ts +0 -16
- package/dist/models/operationalWebhookEndpointUpdate.js +0 -30
- package/dist/models/operationalWebhookEndpointUpdate.js.map +0 -1
- package/dist/models/ordering.d.ts +0 -8
- package/dist/models/ordering.js +0 -17
- package/dist/models/ordering.js.map +0 -1
- package/dist/models/orumIoConfig.d.ts +0 -7
- package/dist/models/orumIoConfig.js +0 -16
- package/dist/models/orumIoConfig.js.map +0 -1
- package/dist/models/orumIoConfigOut.d.ts +0 -7
- package/dist/models/orumIoConfigOut.js +0 -16
- package/dist/models/orumIoConfigOut.js.map +0 -1
- package/dist/models/otelTracingPatchConfig.d.ts +0 -7
- package/dist/models/otelTracingPatchConfig.js +0 -16
- package/dist/models/otelTracingPatchConfig.js.map +0 -1
- package/dist/models/pandaDocConfig.d.ts +0 -7
- package/dist/models/pandaDocConfig.js +0 -16
- package/dist/models/pandaDocConfig.js.map +0 -1
- package/dist/models/pandaDocConfigOut.d.ts +0 -6
- package/dist/models/pandaDocConfigOut.js +0 -12
- package/dist/models/pandaDocConfigOut.js.map +0 -1
- package/dist/models/pollerV2CommitIn.d.ts +0 -7
- package/dist/models/pollerV2CommitIn.js +0 -16
- package/dist/models/pollerV2CommitIn.js.map +0 -1
- package/dist/models/pollerV2MessageOut.d.ts +0 -18
- package/dist/models/pollerV2MessageOut.js +0 -34
- package/dist/models/pollerV2MessageOut.js.map +0 -1
- package/dist/models/pollerV2PollOut.d.ts +0 -9
- package/dist/models/pollerV2PollOut.js +0 -19
- package/dist/models/pollerV2PollOut.js.map +0 -1
- package/dist/models/pollingEndpointConsumerSeekIn.d.ts +0 -7
- package/dist/models/pollingEndpointConsumerSeekIn.js +0 -16
- package/dist/models/pollingEndpointConsumerSeekIn.js.map +0 -1
- package/dist/models/pollingEndpointConsumerSeekOut.d.ts +0 -7
- package/dist/models/pollingEndpointConsumerSeekOut.js +0 -16
- package/dist/models/pollingEndpointConsumerSeekOut.js.map +0 -1
- package/dist/models/pollingEndpointMessageOut.d.ts +0 -17
- package/dist/models/pollingEndpointMessageOut.js +0 -32
- package/dist/models/pollingEndpointMessageOut.js.map +0 -1
- package/dist/models/pollingEndpointOut.d.ts +0 -10
- package/dist/models/pollingEndpointOut.js +0 -21
- package/dist/models/pollingEndpointOut.js.map +0 -1
- package/dist/models/portIoConfig.d.ts +0 -7
- package/dist/models/portIoConfig.js +0 -16
- package/dist/models/portIoConfig.js.map +0 -1
- package/dist/models/portIoConfigOut.d.ts +0 -6
- package/dist/models/portIoConfigOut.js +0 -12
- package/dist/models/portIoConfigOut.js.map +0 -1
- package/dist/models/rabbitMqConfig.d.ts +0 -8
- package/dist/models/rabbitMqConfig.js +0 -18
- package/dist/models/rabbitMqConfig.js.map +0 -1
- package/dist/models/rabbitMqPatchConfig.d.ts +0 -8
- package/dist/models/rabbitMqPatchConfig.js +0 -18
- package/dist/models/rabbitMqPatchConfig.js.map +0 -1
- package/dist/models/recoverIn.d.ts +0 -8
- package/dist/models/recoverIn.js +0 -18
- package/dist/models/recoverIn.js.map +0 -1
- package/dist/models/recoverOut.d.ts +0 -12
- package/dist/models/recoverOut.js +0 -24
- package/dist/models/recoverOut.js.map +0 -1
- package/dist/models/redshiftConfig.d.ts +0 -15
- package/dist/models/redshiftConfig.js +0 -32
- package/dist/models/redshiftConfig.js.map +0 -1
- package/dist/models/redshiftPatchConfig.d.ts +0 -12
- package/dist/models/redshiftPatchConfig.js +0 -26
- package/dist/models/redshiftPatchConfig.js.map +0 -1
- package/dist/models/replayIn.d.ts +0 -8
- package/dist/models/replayIn.js +0 -18
- package/dist/models/replayIn.js.map +0 -1
- package/dist/models/replayOut.d.ts +0 -12
- package/dist/models/replayOut.js +0 -24
- package/dist/models/replayOut.js.map +0 -1
- package/dist/models/rotatePollerTokenIn.d.ts +0 -8
- package/dist/models/rotatePollerTokenIn.js +0 -18
- package/dist/models/rotatePollerTokenIn.js.map +0 -1
- package/dist/models/rotateTokenOut.d.ts +0 -7
- package/dist/models/rotateTokenOut.js +0 -16
- package/dist/models/rotateTokenOut.js.map +0 -1
- package/dist/models/rutterConfig.d.ts +0 -7
- package/dist/models/rutterConfig.js +0 -16
- package/dist/models/rutterConfig.js.map +0 -1
- package/dist/models/rutterConfigOut.d.ts +0 -6
- package/dist/models/rutterConfigOut.js +0 -12
- package/dist/models/rutterConfigOut.js.map +0 -1
- package/dist/models/s3Config.d.ts +0 -11
- package/dist/models/s3Config.js +0 -24
- package/dist/models/s3Config.js.map +0 -1
- package/dist/models/segmentConfig.d.ts +0 -7
- package/dist/models/segmentConfig.js +0 -16
- package/dist/models/segmentConfig.js.map +0 -1
- package/dist/models/segmentConfigOut.d.ts +0 -6
- package/dist/models/segmentConfigOut.js +0 -12
- package/dist/models/segmentConfigOut.js.map +0 -1
- package/dist/models/shopifyConfig.d.ts +0 -7
- package/dist/models/shopifyConfig.js +0 -16
- package/dist/models/shopifyConfig.js.map +0 -1
- package/dist/models/shopifyConfigOut.d.ts +0 -6
- package/dist/models/shopifyConfigOut.js +0 -12
- package/dist/models/shopifyConfigOut.js.map +0 -1
- package/dist/models/sinkHttpConfig.d.ts +0 -11
- package/dist/models/sinkHttpConfig.js +0 -20
- package/dist/models/sinkHttpConfig.js.map +0 -1
- package/dist/models/sinkInCommon.d.ts +0 -17
- package/dist/models/sinkInCommon.js +0 -32
- package/dist/models/sinkInCommon.js.map +0 -1
- package/dist/models/sinkOtelV1Config.d.ts +0 -10
- package/dist/models/sinkOtelV1Config.js +0 -18
- package/dist/models/sinkOtelV1Config.js.map +0 -1
- package/dist/models/sinkSecretOut.d.ts +0 -7
- package/dist/models/sinkSecretOut.js +0 -16
- package/dist/models/sinkSecretOut.js.map +0 -1
- package/dist/models/sinkStatus.d.ts +0 -10
- package/dist/models/sinkStatus.js +0 -19
- package/dist/models/sinkStatus.js.map +0 -1
- package/dist/models/sinkStatusIn.d.ts +0 -8
- package/dist/models/sinkStatusIn.js +0 -17
- package/dist/models/sinkStatusIn.js.map +0 -1
- package/dist/models/sinkTransformIn.d.ts +0 -7
- package/dist/models/sinkTransformIn.js +0 -16
- package/dist/models/sinkTransformIn.js.map +0 -1
- package/dist/models/sinkTransformationOut.d.ts +0 -8
- package/dist/models/sinkTransformationOut.js +0 -18
- package/dist/models/sinkTransformationOut.js.map +0 -1
- package/dist/models/slackConfig.d.ts +0 -7
- package/dist/models/slackConfig.js +0 -16
- package/dist/models/slackConfig.js.map +0 -1
- package/dist/models/slackConfigOut.d.ts +0 -6
- package/dist/models/slackConfigOut.js +0 -12
- package/dist/models/slackConfigOut.js.map +0 -1
- package/dist/models/snowflakeConfig.d.ts +0 -12
- package/dist/models/snowflakeConfig.js +0 -26
- package/dist/models/snowflakeConfig.js.map +0 -1
- package/dist/models/snowflakePatchConfig.d.ts +0 -12
- package/dist/models/snowflakePatchConfig.js +0 -26
- package/dist/models/snowflakePatchConfig.js.map +0 -1
- package/dist/models/snsConfig.d.ts +0 -11
- package/dist/models/snsConfig.js +0 -24
- package/dist/models/snsConfig.js.map +0 -1
- package/dist/models/snsPatchConfig.d.ts +0 -11
- package/dist/models/snsPatchConfig.js +0 -24
- package/dist/models/snsPatchConfig.js.map +0 -1
- package/dist/models/sqsConfig.d.ts +0 -11
- package/dist/models/sqsConfig.js +0 -24
- package/dist/models/sqsConfig.js.map +0 -1
- package/dist/models/sqsPatchConfig.d.ts +0 -11
- package/dist/models/sqsPatchConfig.js +0 -24
- package/dist/models/sqsPatchConfig.js.map +0 -1
- package/dist/models/startingPosition.d.ts +0 -8
- package/dist/models/startingPosition.js +0 -17
- package/dist/models/startingPosition.js.map +0 -1
- package/dist/models/statusCodeClass.d.ts +0 -12
- package/dist/models/statusCodeClass.js +0 -21
- package/dist/models/statusCodeClass.js.map +0 -1
- package/dist/models/streamEventTypeIn.d.ts +0 -11
- package/dist/models/streamEventTypeIn.js +0 -24
- package/dist/models/streamEventTypeIn.js.map +0 -1
- package/dist/models/streamEventTypeOut.d.ts +0 -13
- package/dist/models/streamEventTypeOut.js +0 -28
- package/dist/models/streamEventTypeOut.js.map +0 -1
- package/dist/models/streamEventTypePatch.d.ts +0 -10
- package/dist/models/streamEventTypePatch.js +0 -22
- package/dist/models/streamEventTypePatch.js.map +0 -1
- package/dist/models/streamIn.d.ts +0 -11
- package/dist/models/streamIn.js +0 -20
- package/dist/models/streamIn.js.map +0 -1
- package/dist/models/streamOut.d.ts +0 -14
- package/dist/models/streamOut.js +0 -26
- package/dist/models/streamOut.js.map +0 -1
- package/dist/models/streamPatch.d.ts +0 -11
- package/dist/models/streamPatch.js +0 -20
- package/dist/models/streamPatch.js.map +0 -1
- package/dist/models/streamPortalAccessIn.d.ts +0 -9
- package/dist/models/streamPortalAccessIn.js +0 -20
- package/dist/models/streamPortalAccessIn.js.map +0 -1
- package/dist/models/streamSinkIn.d.ts +0 -93
- package/dist/models/streamSinkIn.js +0 -134
- package/dist/models/streamSinkIn.js.map +0 -1
- package/dist/models/streamSinkOut.d.ts +0 -99
- package/dist/models/streamSinkOut.js +0 -142
- package/dist/models/streamSinkOut.js.map +0 -1
- package/dist/models/streamSinkPatch.d.ts +0 -93
- package/dist/models/streamSinkPatch.js +0 -134
- package/dist/models/streamSinkPatch.js.map +0 -1
- package/dist/models/streamTokenExpireIn.d.ts +0 -8
- package/dist/models/streamTokenExpireIn.js +0 -18
- package/dist/models/streamTokenExpireIn.js.map +0 -1
- package/dist/models/stripeConfig.d.ts +0 -7
- package/dist/models/stripeConfig.js +0 -16
- package/dist/models/stripeConfig.js.map +0 -1
- package/dist/models/stripeConfigOut.d.ts +0 -6
- package/dist/models/stripeConfigOut.js +0 -12
- package/dist/models/stripeConfigOut.js.map +0 -1
- package/dist/models/subscribeIn.d.ts +0 -10
- package/dist/models/subscribeIn.js +0 -28
- package/dist/models/subscribeIn.js.map +0 -1
- package/dist/models/svixConfig.d.ts +0 -7
- package/dist/models/svixConfig.js +0 -16
- package/dist/models/svixConfig.js.map +0 -1
- package/dist/models/svixConfigOut.d.ts +0 -6
- package/dist/models/svixConfigOut.js +0 -12
- package/dist/models/svixConfigOut.js.map +0 -1
- package/dist/models/tailscaleConfig.d.ts +0 -8
- package/dist/models/tailscaleConfig.js +0 -18
- package/dist/models/tailscaleConfig.js.map +0 -1
- package/dist/models/tailscaleConfigOut.d.ts +0 -6
- package/dist/models/tailscaleConfigOut.js +0 -12
- package/dist/models/tailscaleConfigOut.js.map +0 -1
- package/dist/models/telnyxConfig.d.ts +0 -7
- package/dist/models/telnyxConfig.js +0 -16
- package/dist/models/telnyxConfig.js.map +0 -1
- package/dist/models/telnyxConfigOut.d.ts +0 -7
- package/dist/models/telnyxConfigOut.js +0 -16
- package/dist/models/telnyxConfigOut.js.map +0 -1
- package/dist/models/vapiConfig.d.ts +0 -7
- package/dist/models/vapiConfig.js +0 -16
- package/dist/models/vapiConfig.js.map +0 -1
- package/dist/models/vapiConfigOut.d.ts +0 -6
- package/dist/models/vapiConfigOut.js +0 -12
- package/dist/models/vapiConfigOut.js.map +0 -1
- package/dist/models/veriffConfig.d.ts +0 -7
- package/dist/models/veriffConfig.js +0 -16
- package/dist/models/veriffConfig.js.map +0 -1
- package/dist/models/veriffConfigOut.d.ts +0 -6
- package/dist/models/veriffConfigOut.js +0 -12
- package/dist/models/veriffConfigOut.js.map +0 -1
- package/dist/models/vgsConfig.d.ts +0 -7
- package/dist/models/vgsConfig.js +0 -16
- package/dist/models/vgsConfig.js.map +0 -1
- package/dist/models/vgsConfigOut.d.ts +0 -6
- package/dist/models/vgsConfigOut.js +0 -12
- package/dist/models/vgsConfigOut.js.map +0 -1
- package/dist/models/zoomConfig.d.ts +0 -7
- package/dist/models/zoomConfig.js +0 -16
- package/dist/models/zoomConfig.js.map +0 -1
- package/dist/models/zoomConfigOut.d.ts +0 -6
- package/dist/models/zoomConfigOut.js +0 -12
- package/dist/models/zoomConfigOut.js.map +0 -1
- package/dist/request.d.ts +0 -43
- package/dist/request.js +0 -172
- package/dist/request.js.map +0 -1
- package/dist/util.d.ts +0 -14
- package/dist/util.js +0 -16
- package/dist/util.js.map +0 -1
- package/dist/webhook.d.ts +0 -22
- package/dist/webhook.js +0 -29
- package/dist/webhook.js.map +0 -1
- package/src/models/azureBlobStorageConfig.ts +0 -25
- package/src/models/backgroundTaskFinishedEvent.ts +0 -27
- package/src/models/backgroundTaskFinishedEvent2.ts +0 -37
- package/src/models/clickhouseConfig.ts +0 -36
- package/src/models/dashboardAccessOut.ts +0 -22
- package/src/models/endpointCreatedEvent.ts +0 -27
- package/src/models/endpointCreatedEventData.ts +0 -33
- package/src/models/endpointDeletedEvent.ts +0 -27
- package/src/models/endpointDeletedEventData.ts +0 -33
- package/src/models/endpointDisabledEvent.ts +0 -27
- package/src/models/endpointDisabledEventData.ts +0 -49
- package/src/models/endpointDisabledTrigger.ts +0 -16
- package/src/models/endpointEnabledEvent.ts +0 -27
- package/src/models/endpointEnabledEventData.ts +0 -33
- package/src/models/endpointUpdatedEvent.ts +0 -27
- package/src/models/endpointUpdatedEventData.ts +0 -33
- package/src/models/eventBridgeConfig.ts +0 -33
- package/src/models/httpAttemptTimes.ts +0 -22
- package/src/models/httpPatchConfig.ts +0 -19
- package/src/models/ingestEndpointDisabledEvent.ts +0 -27
- package/src/models/ingestEndpointDisabledEventData.ts +0 -45
- package/src/models/ingestMessageAttemptExhaustedEvent.ts +0 -29
- package/src/models/ingestMessageAttemptExhaustedEventData.ts +0 -42
- package/src/models/ingestMessageAttemptFailingEvent.ts +0 -32
- package/src/models/ingestMessageAttemptFailingEventData.ts +0 -42
- package/src/models/ingestMessageAttemptRecoveredEvent.ts +0 -29
- package/src/models/ingestMessageAttemptRecoveredEventData.ts +0 -42
- package/src/models/messageAttemptExhaustedEvent.ts +0 -27
- package/src/models/messageAttemptExhaustedEventData.ts +0 -46
- package/src/models/messageAttemptFailedData.ts +0 -26
- package/src/models/messageAttemptFailingEvent.ts +0 -30
- package/src/models/messageAttemptFailingEventData.ts +0 -46
- package/src/models/messageAttemptLog.ts +0 -77
- package/src/models/messageAttemptLogEvent.ts +0 -26
- package/src/models/messageAttemptRecoveredEvent.ts +0 -27
- package/src/models/messageAttemptRecoveredEventData.ts +0 -46
- package/src/models/otelTracingPatchConfig.ts +0 -19
- package/src/models/snsConfig.ts +0 -32
package/dist/index.d.mts
ADDED
|
@@ -0,0 +1,4312 @@
|
|
|
1
|
+
import { WebhookVerificationError } from "standardwebhooks";
|
|
2
|
+
//#region src/models/applicationIn.d.ts
|
|
3
|
+
interface ApplicationIn {
|
|
4
|
+
/** Application name for human consumption. */
|
|
5
|
+
name: string;
|
|
6
|
+
/**
|
|
7
|
+
* Maximum messages per second to send to this application.
|
|
8
|
+
*
|
|
9
|
+
* Outgoing messages will be throttled to this rate.
|
|
10
|
+
*/
|
|
11
|
+
throttleRate?: number | null;
|
|
12
|
+
/** Optional unique identifier for the application. */
|
|
13
|
+
uid?: string | null;
|
|
14
|
+
metadata?: {
|
|
15
|
+
[key: string]: string;
|
|
16
|
+
};
|
|
17
|
+
}
|
|
18
|
+
//#endregion
|
|
19
|
+
//#region src/models/applicationOut.d.ts
|
|
20
|
+
interface ApplicationOut {
|
|
21
|
+
/** Optional unique identifier for the application. */
|
|
22
|
+
uid?: string | null;
|
|
23
|
+
/** Application name for human consumption. */
|
|
24
|
+
name: string;
|
|
25
|
+
/**
|
|
26
|
+
* Maximum messages per second to send to this application.
|
|
27
|
+
*
|
|
28
|
+
* Outgoing messages will be throttled to this rate.
|
|
29
|
+
*/
|
|
30
|
+
throttleRate?: number | null;
|
|
31
|
+
/** The Application's ID. */
|
|
32
|
+
id: string;
|
|
33
|
+
createdAt: Date;
|
|
34
|
+
updatedAt: Date;
|
|
35
|
+
metadata: {
|
|
36
|
+
[key: string]: string;
|
|
37
|
+
};
|
|
38
|
+
}
|
|
39
|
+
//#endregion
|
|
40
|
+
//#region src/models/applicationPatch.d.ts
|
|
41
|
+
interface ApplicationPatch {
|
|
42
|
+
name?: string;
|
|
43
|
+
/**
|
|
44
|
+
* Maximum messages per second to send to this application.
|
|
45
|
+
*
|
|
46
|
+
* Outgoing messages will be throttled to this rate.
|
|
47
|
+
*/
|
|
48
|
+
throttleRate?: number | null;
|
|
49
|
+
/** The Application's UID. */
|
|
50
|
+
uid?: string | null;
|
|
51
|
+
metadata?: {
|
|
52
|
+
[key: string]: string;
|
|
53
|
+
};
|
|
54
|
+
}
|
|
55
|
+
//#endregion
|
|
56
|
+
//#region src/models/listResponseApplicationOut.d.ts
|
|
57
|
+
interface ListResponseApplicationOut {
|
|
58
|
+
data: ApplicationOut[];
|
|
59
|
+
iterator: string | null;
|
|
60
|
+
prevIterator?: string | null;
|
|
61
|
+
done: boolean;
|
|
62
|
+
}
|
|
63
|
+
//#endregion
|
|
64
|
+
//#region src/models/ordering.d.ts
|
|
65
|
+
/** Defines the ordering in a listing of results. */
|
|
66
|
+
declare enum Ordering {
|
|
67
|
+
Ascending = "ascending",
|
|
68
|
+
Descending = "descending"
|
|
69
|
+
}
|
|
70
|
+
//#endregion
|
|
71
|
+
//#region src/util.d.ts
|
|
72
|
+
interface PostOptions {
|
|
73
|
+
idempotencyKey?: string;
|
|
74
|
+
}
|
|
75
|
+
declare class ApiException<T> extends Error {
|
|
76
|
+
code: number;
|
|
77
|
+
body: T;
|
|
78
|
+
headers: Record<string, string>;
|
|
79
|
+
constructor(code: number, body: T, headers: Headers);
|
|
80
|
+
}
|
|
81
|
+
type XOR<T, U> = (T & { [K in keyof U]?: never; }) | (U & { [K in keyof T]?: never; });
|
|
82
|
+
//#endregion
|
|
83
|
+
//#region src/request.d.ts
|
|
84
|
+
type SvixRequestContext = {
|
|
85
|
+
/** The API base URL, like "https://api.svix.com" */
|
|
86
|
+
baseUrl: string;
|
|
87
|
+
/** The 'bearer' scheme access token */
|
|
88
|
+
token: string;
|
|
89
|
+
/** Time in milliseconds to wait for requests to get a response. */
|
|
90
|
+
timeout?: number;
|
|
91
|
+
/**
|
|
92
|
+
* Custom fetch implementation to use for HTTP requests.
|
|
93
|
+
* Useful for testing, adding custom middleware, or running in non-standard environments.
|
|
94
|
+
*/
|
|
95
|
+
fetch?: typeof fetch;
|
|
96
|
+
} & XOR<{
|
|
97
|
+
/** List of delays (in milliseconds) to wait before each retry attempt.*/
|
|
98
|
+
retryScheduleInMs?: number[];
|
|
99
|
+
}, {
|
|
100
|
+
/** The number of times the client will retry if a server-side error
|
|
101
|
+
* or timeout is received.
|
|
102
|
+
* Default: 2
|
|
103
|
+
*/
|
|
104
|
+
numRetries?: number;
|
|
105
|
+
}>;
|
|
106
|
+
//#endregion
|
|
107
|
+
//#region src/api/application.d.ts
|
|
108
|
+
interface ApplicationListOptions {
|
|
109
|
+
/** Exclude applications that have no endpoints. Default is false. */
|
|
110
|
+
excludeAppsWithNoEndpoints?: boolean;
|
|
111
|
+
/** Exclude applications that have only disabled endpoints. Default is false. */
|
|
112
|
+
excludeAppsWithDisabledEndpoints?: boolean;
|
|
113
|
+
/** Exclude applications that only have Svix Play endpoints. Default is false. */
|
|
114
|
+
excludeAppsWithSvixPlayEndpoints?: boolean;
|
|
115
|
+
/** Limit the number of returned items */
|
|
116
|
+
limit?: number;
|
|
117
|
+
/** The iterator returned from a prior invocation */
|
|
118
|
+
iterator?: string | null;
|
|
119
|
+
/** The sorting order of the returned items */
|
|
120
|
+
order?: Ordering;
|
|
121
|
+
}
|
|
122
|
+
interface ApplicationCreateOptions {
|
|
123
|
+
idempotencyKey?: string;
|
|
124
|
+
}
|
|
125
|
+
declare class Application {
|
|
126
|
+
private readonly requestCtx;
|
|
127
|
+
constructor(requestCtx: SvixRequestContext);
|
|
128
|
+
/** List of all the organization's applications. */
|
|
129
|
+
list(options?: ApplicationListOptions): Promise<ListResponseApplicationOut>;
|
|
130
|
+
/** Create a new application. */
|
|
131
|
+
create(applicationIn: ApplicationIn, options?: ApplicationCreateOptions): Promise<ApplicationOut>;
|
|
132
|
+
/** Get the application with the UID from `applicationIn`, or create it if it doesn't exist yet. */
|
|
133
|
+
getOrCreate(applicationIn: ApplicationIn, options?: ApplicationCreateOptions): Promise<ApplicationOut>;
|
|
134
|
+
/** Get an application. */
|
|
135
|
+
get(appId: string): Promise<ApplicationOut>;
|
|
136
|
+
/** Create or update an application. */
|
|
137
|
+
upsert(appId: string, applicationIn: ApplicationIn): Promise<ApplicationOut>;
|
|
138
|
+
/** Delete an application. */
|
|
139
|
+
delete(appId: string): Promise<void>;
|
|
140
|
+
/** Partially update an application. */
|
|
141
|
+
patch(appId: string, applicationPatch: ApplicationPatch): Promise<ApplicationOut>;
|
|
142
|
+
}
|
|
143
|
+
//#endregion
|
|
144
|
+
//#region src/models/apiTokenOut.d.ts
|
|
145
|
+
interface ApiTokenOut {
|
|
146
|
+
token: string;
|
|
147
|
+
id: string;
|
|
148
|
+
name?: string | null;
|
|
149
|
+
createdAt: Date;
|
|
150
|
+
expiresAt?: Date | null;
|
|
151
|
+
scopes?: string[] | null;
|
|
152
|
+
}
|
|
153
|
+
//#endregion
|
|
154
|
+
//#region src/models/appPortalCapability.d.ts
|
|
155
|
+
declare enum AppPortalCapability {
|
|
156
|
+
ViewBase = "ViewBase",
|
|
157
|
+
ViewEndpointSecret = "ViewEndpointSecret",
|
|
158
|
+
ManageEndpointSecret = "ManageEndpointSecret",
|
|
159
|
+
ManageTransformations = "ManageTransformations",
|
|
160
|
+
CreateAttempts = "CreateAttempts",
|
|
161
|
+
ManageEndpoint = "ManageEndpoint"
|
|
162
|
+
}
|
|
163
|
+
//#endregion
|
|
164
|
+
//#region src/models/appPortalAccessIn.d.ts
|
|
165
|
+
interface AppPortalAccessIn {
|
|
166
|
+
/**
|
|
167
|
+
* Optionally creates a new application while generating the access link.
|
|
168
|
+
*
|
|
169
|
+
* If the application id or uid that is used in the path already exists, this argument is ignored.
|
|
170
|
+
*/
|
|
171
|
+
application?: ApplicationIn | null;
|
|
172
|
+
/**
|
|
173
|
+
* Whether the app portal should be in read-only mode.
|
|
174
|
+
*
|
|
175
|
+
* @deprecated
|
|
176
|
+
*/
|
|
177
|
+
readOnly?: boolean | null;
|
|
178
|
+
/**
|
|
179
|
+
* Custom capabilities attached to the token, You can combine as many capabilities as necessary.
|
|
180
|
+
*
|
|
181
|
+
* The `ViewBase` capability is always required
|
|
182
|
+
*
|
|
183
|
+
* - `ViewBase`: Basic read only permissions, does not allow the user to see the endpoint secret.
|
|
184
|
+
*
|
|
185
|
+
* - `ViewEndpointSecret`: Allows user to view the endpoint secret.
|
|
186
|
+
*
|
|
187
|
+
* - `ManageEndpointSecret`: Allows user to rotate and view the endpoint secret.
|
|
188
|
+
*
|
|
189
|
+
* - `ManageTransformations`: Allows user to modify the endpoint transformations.
|
|
190
|
+
*
|
|
191
|
+
* - `CreateAttempts`: Allows user to replay missing messages and send example messages.
|
|
192
|
+
*
|
|
193
|
+
* - `ManageEndpoint`: Allows user to read/modify any field or configuration of an endpoint (including secrets)
|
|
194
|
+
*
|
|
195
|
+
* By default, the token will get all capabilities if the capabilities are not explicitly specified.
|
|
196
|
+
*/
|
|
197
|
+
capabilities?: AppPortalCapability[] | null;
|
|
198
|
+
/** The set of feature flags the created token will have access to. */
|
|
199
|
+
featureFlags?: string[];
|
|
200
|
+
/**
|
|
201
|
+
* How long the token will be valid for, in seconds.
|
|
202
|
+
*
|
|
203
|
+
* Valid values are between 1 hour and 7 days. The default is 7 days.
|
|
204
|
+
*/
|
|
205
|
+
expiry?: number | null;
|
|
206
|
+
/**
|
|
207
|
+
* An optional session ID to attach to the token.
|
|
208
|
+
*
|
|
209
|
+
* When expiring tokens with "Expire All", you can include the session ID to only expire tokens that were created with that session ID.
|
|
210
|
+
*/
|
|
211
|
+
sessionId?: string | null;
|
|
212
|
+
}
|
|
213
|
+
//#endregion
|
|
214
|
+
//#region src/models/appPortalAccessOut.d.ts
|
|
215
|
+
interface AppPortalAccessOut {
|
|
216
|
+
url: string;
|
|
217
|
+
token: string;
|
|
218
|
+
}
|
|
219
|
+
//#endregion
|
|
220
|
+
//#region src/models/applicationTokenExpireIn.d.ts
|
|
221
|
+
interface ApplicationTokenExpireIn {
|
|
222
|
+
/** How many seconds until the old key is expired. */
|
|
223
|
+
expiry?: number | null;
|
|
224
|
+
/**
|
|
225
|
+
* An optional list of session ids.
|
|
226
|
+
*
|
|
227
|
+
* If any session ids are specified, only Application tokens created with that session id will be expired.
|
|
228
|
+
*/
|
|
229
|
+
sessionIds?: string[];
|
|
230
|
+
}
|
|
231
|
+
//#endregion
|
|
232
|
+
//#region src/models/rotatePollerTokenIn.d.ts
|
|
233
|
+
interface RotatePollerTokenIn {
|
|
234
|
+
/** How long the token will be valid for, in seconds. Can be up to 31,536,000 seconds (1 year). */
|
|
235
|
+
expiry?: number | null;
|
|
236
|
+
/**
|
|
237
|
+
* Updates the previous token's expiration, in seconds.
|
|
238
|
+
*
|
|
239
|
+
* If set to 0, the old token will immediately be revoked. Must be between 0 and 86,400 seconds (1 day).
|
|
240
|
+
*
|
|
241
|
+
* Defaults to 300 seconds (5 minutes).
|
|
242
|
+
*/
|
|
243
|
+
oldTokenExpiry?: number;
|
|
244
|
+
}
|
|
245
|
+
//#endregion
|
|
246
|
+
//#region src/models/streamPortalAccessIn.d.ts
|
|
247
|
+
interface StreamPortalAccessIn {
|
|
248
|
+
/** The set of feature flags the created token will have access to. */
|
|
249
|
+
featureFlags?: string[];
|
|
250
|
+
/**
|
|
251
|
+
* How long the token will be valid for, in seconds.
|
|
252
|
+
*
|
|
253
|
+
* Valid values are between 1 hour and 7 days. The default is 7 days.
|
|
254
|
+
*/
|
|
255
|
+
expiry?: number | null;
|
|
256
|
+
/**
|
|
257
|
+
* An optional session ID to attach to the token.
|
|
258
|
+
*
|
|
259
|
+
* When expiring tokens with "Expire All", you can include the session ID to only expire tokens that were created with that session ID.
|
|
260
|
+
*/
|
|
261
|
+
sessionId?: string | null;
|
|
262
|
+
}
|
|
263
|
+
//#endregion
|
|
264
|
+
//#region src/models/streamTokenExpireIn.d.ts
|
|
265
|
+
interface StreamTokenExpireIn {
|
|
266
|
+
/** How many seconds until the old key is expired. */
|
|
267
|
+
expiry?: number | null;
|
|
268
|
+
/**
|
|
269
|
+
* An optional list of session ids.
|
|
270
|
+
*
|
|
271
|
+
* If any session ids are specified, only Stream tokens created with that session id will be expired.
|
|
272
|
+
*/
|
|
273
|
+
sessionIds?: string[];
|
|
274
|
+
}
|
|
275
|
+
//#endregion
|
|
276
|
+
//#region src/api/authentication.d.ts
|
|
277
|
+
interface AuthenticationAppPortalAccessOptions {
|
|
278
|
+
idempotencyKey?: string;
|
|
279
|
+
}
|
|
280
|
+
interface AuthenticationLogoutOptions {
|
|
281
|
+
idempotencyKey?: string;
|
|
282
|
+
}
|
|
283
|
+
interface AuthenticationExpireAllOptions {
|
|
284
|
+
idempotencyKey?: string;
|
|
285
|
+
}
|
|
286
|
+
interface AuthenticationStreamPortalAccessOptions {
|
|
287
|
+
idempotencyKey?: string;
|
|
288
|
+
}
|
|
289
|
+
interface AuthenticationStreamLogoutOptions {
|
|
290
|
+
idempotencyKey?: string;
|
|
291
|
+
}
|
|
292
|
+
interface AuthenticationStreamExpireAllOptions {
|
|
293
|
+
idempotencyKey?: string;
|
|
294
|
+
}
|
|
295
|
+
interface AuthenticationRotateStreamPollerTokenOptions {
|
|
296
|
+
idempotencyKey?: string;
|
|
297
|
+
}
|
|
298
|
+
declare class Authentication {
|
|
299
|
+
private readonly requestCtx;
|
|
300
|
+
constructor(requestCtx: SvixRequestContext);
|
|
301
|
+
/** Use this function to get magic links (and authentication codes) for connecting your users to the Consumer Application Portal. */
|
|
302
|
+
appPortalAccess(appId: string, appPortalAccessIn?: AppPortalAccessIn, options?: AuthenticationAppPortalAccessOptions): Promise<AppPortalAccessOut>;
|
|
303
|
+
/**
|
|
304
|
+
* Logout an app token.
|
|
305
|
+
*
|
|
306
|
+
* Trying to log out other tokens will fail.
|
|
307
|
+
*/
|
|
308
|
+
logout(options?: AuthenticationLogoutOptions): Promise<void>;
|
|
309
|
+
/** Expire all of the tokens associated with a specific application. */
|
|
310
|
+
expireAll(appId: string, applicationTokenExpireIn?: ApplicationTokenExpireIn, options?: AuthenticationExpireAllOptions): Promise<void>;
|
|
311
|
+
/** Use this function to get magic links (and authentication codes) for connecting your users to the Stream Consumer Portal. */
|
|
312
|
+
streamPortalAccess(streamId: string, streamPortalAccessIn?: StreamPortalAccessIn, options?: AuthenticationStreamPortalAccessOptions): Promise<AppPortalAccessOut>;
|
|
313
|
+
/**
|
|
314
|
+
* Logout a stream token.
|
|
315
|
+
*
|
|
316
|
+
* Trying to log out other tokens will fail.
|
|
317
|
+
*/
|
|
318
|
+
streamLogout(options?: AuthenticationStreamLogoutOptions): Promise<void>;
|
|
319
|
+
/** Expire all of the tokens associated with a specific stream. */
|
|
320
|
+
streamExpireAll(streamId: string, streamTokenExpireIn?: StreamTokenExpireIn, options?: AuthenticationStreamExpireAllOptions): Promise<void>;
|
|
321
|
+
/** Create a new auth token for the stream poller API. */
|
|
322
|
+
rotateStreamPollerToken(streamId: string, sinkId: string, rotatePollerTokenIn?: RotatePollerTokenIn, options?: AuthenticationRotateStreamPollerTokenOptions): Promise<ApiTokenOut>;
|
|
323
|
+
/** Get the current auth token for the stream poller. */
|
|
324
|
+
getStreamPollerToken(streamId: string, sinkId: string): Promise<ApiTokenOut>;
|
|
325
|
+
}
|
|
326
|
+
//#endregion
|
|
327
|
+
//#region src/models/backgroundTaskStatus.d.ts
|
|
328
|
+
declare enum BackgroundTaskStatus {
|
|
329
|
+
Running = "running",
|
|
330
|
+
Finished = "finished",
|
|
331
|
+
Failed = "failed"
|
|
332
|
+
}
|
|
333
|
+
//#endregion
|
|
334
|
+
//#region src/models/backgroundTaskType.d.ts
|
|
335
|
+
declare enum BackgroundTaskType {
|
|
336
|
+
EndpointReplay = "endpoint.replay",
|
|
337
|
+
EndpointRecover = "endpoint.recover",
|
|
338
|
+
ApplicationStats = "application.stats",
|
|
339
|
+
MessageBroadcast = "message.broadcast",
|
|
340
|
+
SdkGenerate = "sdk.generate",
|
|
341
|
+
EventTypeAggregate = "event-type.aggregate",
|
|
342
|
+
ApplicationPurgeContent = "application.purge_content",
|
|
343
|
+
EndpointBulkReplay = "endpoint.bulk-replay"
|
|
344
|
+
}
|
|
345
|
+
//#endregion
|
|
346
|
+
//#region src/models/backgroundTaskOut.d.ts
|
|
347
|
+
interface BackgroundTaskOut {
|
|
348
|
+
data: any;
|
|
349
|
+
/** The QueueBackgroundTask's ID. */
|
|
350
|
+
id: string;
|
|
351
|
+
status: BackgroundTaskStatus;
|
|
352
|
+
task: BackgroundTaskType;
|
|
353
|
+
updatedAt: Date;
|
|
354
|
+
}
|
|
355
|
+
//#endregion
|
|
356
|
+
//#region src/models/listResponseBackgroundTaskOut.d.ts
|
|
357
|
+
interface ListResponseBackgroundTaskOut {
|
|
358
|
+
data: BackgroundTaskOut[];
|
|
359
|
+
iterator: string | null;
|
|
360
|
+
prevIterator?: string | null;
|
|
361
|
+
done: boolean;
|
|
362
|
+
}
|
|
363
|
+
//#endregion
|
|
364
|
+
//#region src/api/backgroundTask.d.ts
|
|
365
|
+
interface BackgroundTaskListOptions {
|
|
366
|
+
/** Filter the response based on the status. */
|
|
367
|
+
status?: BackgroundTaskStatus;
|
|
368
|
+
/** Filter the response based on the type. */
|
|
369
|
+
task?: BackgroundTaskType;
|
|
370
|
+
/** Limit the number of returned items */
|
|
371
|
+
limit?: number;
|
|
372
|
+
/** The iterator returned from a prior invocation */
|
|
373
|
+
iterator?: string | null;
|
|
374
|
+
/** The sorting order of the returned items */
|
|
375
|
+
order?: Ordering;
|
|
376
|
+
}
|
|
377
|
+
declare class BackgroundTask {
|
|
378
|
+
private readonly requestCtx;
|
|
379
|
+
constructor(requestCtx: SvixRequestContext);
|
|
380
|
+
/** List background tasks executed in the past 90 days. */
|
|
381
|
+
list(options?: BackgroundTaskListOptions): Promise<ListResponseBackgroundTaskOut>;
|
|
382
|
+
/** Get a background task by ID. */
|
|
383
|
+
get(taskId: string): Promise<BackgroundTaskOut>;
|
|
384
|
+
}
|
|
385
|
+
//#endregion
|
|
386
|
+
//#region src/models/connectorKind.d.ts
|
|
387
|
+
declare enum ConnectorKind {
|
|
388
|
+
Custom = "Custom",
|
|
389
|
+
AgenticCommerceProtocol = "AgenticCommerceProtocol",
|
|
390
|
+
CloseCrm = "CloseCRM",
|
|
391
|
+
CustomerIo = "CustomerIO",
|
|
392
|
+
Discord = "Discord",
|
|
393
|
+
Hubspot = "Hubspot",
|
|
394
|
+
Inngest = "Inngest",
|
|
395
|
+
Loops = "Loops",
|
|
396
|
+
Otel = "Otel",
|
|
397
|
+
Resend = "Resend",
|
|
398
|
+
Salesforce = "Salesforce",
|
|
399
|
+
Segment = "Segment",
|
|
400
|
+
Sendgrid = "Sendgrid",
|
|
401
|
+
Slack = "Slack",
|
|
402
|
+
Teams = "Teams",
|
|
403
|
+
TriggerDev = "TriggerDev",
|
|
404
|
+
Windmill = "Windmill",
|
|
405
|
+
Zapier = "Zapier"
|
|
406
|
+
}
|
|
407
|
+
//#endregion
|
|
408
|
+
//#region src/models/connectorProduct.d.ts
|
|
409
|
+
declare enum ConnectorProduct {
|
|
410
|
+
Dispatch = "Dispatch",
|
|
411
|
+
Stream = "Stream"
|
|
412
|
+
}
|
|
413
|
+
//#endregion
|
|
414
|
+
//#region src/models/connectorIn.d.ts
|
|
415
|
+
interface ConnectorIn {
|
|
416
|
+
name: string;
|
|
417
|
+
/** The Connector's UID. */
|
|
418
|
+
uid?: string | null;
|
|
419
|
+
logo?: string | null;
|
|
420
|
+
description?: string;
|
|
421
|
+
kind?: ConnectorKind;
|
|
422
|
+
instructions?: string;
|
|
423
|
+
allowedEventTypes?: string[] | null;
|
|
424
|
+
transformation: string;
|
|
425
|
+
featureFlags?: string[] | null;
|
|
426
|
+
productType?: ConnectorProduct | null;
|
|
427
|
+
}
|
|
428
|
+
//#endregion
|
|
429
|
+
//#region src/models/connectorOut.d.ts
|
|
430
|
+
interface ConnectorOut {
|
|
431
|
+
/** The Connector's ID. */
|
|
432
|
+
id: string;
|
|
433
|
+
/** The Environment's ID. */
|
|
434
|
+
orgId: string;
|
|
435
|
+
/** The Connector's UID. */
|
|
436
|
+
uid?: string | null;
|
|
437
|
+
kind: ConnectorKind;
|
|
438
|
+
name: string;
|
|
439
|
+
logo?: string | null;
|
|
440
|
+
description: string;
|
|
441
|
+
instructions: string;
|
|
442
|
+
allowedEventTypes?: string[] | null;
|
|
443
|
+
transformation: string;
|
|
444
|
+
createdAt: Date;
|
|
445
|
+
updatedAt: Date;
|
|
446
|
+
transformationUpdatedAt: Date;
|
|
447
|
+
featureFlags?: string[] | null;
|
|
448
|
+
productType: ConnectorProduct;
|
|
449
|
+
}
|
|
450
|
+
//#endregion
|
|
451
|
+
//#region src/models/connectorPatch.d.ts
|
|
452
|
+
interface ConnectorPatch {
|
|
453
|
+
name?: string;
|
|
454
|
+
logo?: string | null;
|
|
455
|
+
description?: string;
|
|
456
|
+
kind?: ConnectorKind;
|
|
457
|
+
instructions?: string;
|
|
458
|
+
allowedEventTypes?: string[] | null;
|
|
459
|
+
transformation?: string;
|
|
460
|
+
featureFlags?: string[] | null;
|
|
461
|
+
}
|
|
462
|
+
//#endregion
|
|
463
|
+
//#region src/models/connectorUpsertIn.d.ts
|
|
464
|
+
interface ConnectorUpsertIn {
|
|
465
|
+
name?: string;
|
|
466
|
+
logo?: string | null;
|
|
467
|
+
description?: string;
|
|
468
|
+
kind?: ConnectorKind;
|
|
469
|
+
instructions?: string;
|
|
470
|
+
allowedEventTypes?: string[] | null;
|
|
471
|
+
transformation: string;
|
|
472
|
+
featureFlags?: string[] | null;
|
|
473
|
+
}
|
|
474
|
+
//#endregion
|
|
475
|
+
//#region src/models/listResponseConnectorOut.d.ts
|
|
476
|
+
interface ListResponseConnectorOut {
|
|
477
|
+
data: ConnectorOut[];
|
|
478
|
+
iterator: string | null;
|
|
479
|
+
prevIterator?: string | null;
|
|
480
|
+
done: boolean;
|
|
481
|
+
}
|
|
482
|
+
//#endregion
|
|
483
|
+
//#region src/api/connector.d.ts
|
|
484
|
+
interface ConnectorListOptions {
|
|
485
|
+
/** Limit the number of returned items */
|
|
486
|
+
limit?: number;
|
|
487
|
+
/** The iterator returned from a prior invocation */
|
|
488
|
+
iterator?: string | null;
|
|
489
|
+
/** The sorting order of the returned items */
|
|
490
|
+
order?: Ordering;
|
|
491
|
+
productType?: ConnectorProduct;
|
|
492
|
+
}
|
|
493
|
+
interface ConnectorCreateOptions {
|
|
494
|
+
idempotencyKey?: string;
|
|
495
|
+
}
|
|
496
|
+
declare class Connector {
|
|
497
|
+
private readonly requestCtx;
|
|
498
|
+
constructor(requestCtx: SvixRequestContext);
|
|
499
|
+
/** List all connectors for an application. */
|
|
500
|
+
list(options?: ConnectorListOptions): Promise<ListResponseConnectorOut>;
|
|
501
|
+
/** Create a new connector. */
|
|
502
|
+
create(connectorIn: ConnectorIn, options?: ConnectorCreateOptions): Promise<ConnectorOut>;
|
|
503
|
+
/** Get a connector. */
|
|
504
|
+
get(connectorId: string): Promise<ConnectorOut>;
|
|
505
|
+
/** Create or update a connector. */
|
|
506
|
+
upsert(connectorId: string, connectorUpsertIn: ConnectorUpsertIn): Promise<ConnectorOut>;
|
|
507
|
+
/** Delete a connector. */
|
|
508
|
+
delete(connectorId: string): Promise<void>;
|
|
509
|
+
/** Partially update a connector. */
|
|
510
|
+
patch(connectorId: string, connectorPatch: ConnectorPatch): Promise<ConnectorOut>;
|
|
511
|
+
}
|
|
512
|
+
//#endregion
|
|
513
|
+
//#region src/models/messageStatus.d.ts
|
|
514
|
+
/**
|
|
515
|
+
* The sending status of the message:
|
|
516
|
+
*
|
|
517
|
+
* - Success = 0
|
|
518
|
+
* - Pending = 1
|
|
519
|
+
* - Fail = 2
|
|
520
|
+
* - Sending = 3
|
|
521
|
+
* - Canceled = 4
|
|
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[];
|
|
580
|
+
}
|
|
581
|
+
//#endregion
|
|
582
|
+
//#region src/models/endpointHeadersPatchIn.d.ts
|
|
583
|
+
interface EndpointHeadersPatchIn {
|
|
584
|
+
headers: {
|
|
585
|
+
[key: string]: string;
|
|
586
|
+
};
|
|
587
|
+
/** A list of headers be be removed */
|
|
588
|
+
deleteHeaders?: string[];
|
|
589
|
+
}
|
|
590
|
+
//#endregion
|
|
591
|
+
//#region src/models/endpointIn.d.ts
|
|
592
|
+
interface EndpointIn {
|
|
593
|
+
url: string;
|
|
594
|
+
description?: string;
|
|
595
|
+
/**
|
|
596
|
+
* Maximum messages per second to send to this endpoint.
|
|
597
|
+
*
|
|
598
|
+
* Outgoing messages will be throttled to this rate.
|
|
599
|
+
*/
|
|
600
|
+
throttleRate?: number | null;
|
|
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;
|
|
607
|
+
/**
|
|
608
|
+
* The endpoint's verification secret.
|
|
609
|
+
*
|
|
610
|
+
* Format: `base64` encoded random bytes optionally prefixed with `whsec_`.
|
|
611
|
+
* It is recommended to not set this and let the server generate the secret.
|
|
612
|
+
*/
|
|
613
|
+
secret?: string | null;
|
|
614
|
+
metadata?: {
|
|
615
|
+
[key: string]: string;
|
|
616
|
+
};
|
|
617
|
+
headers?: {
|
|
618
|
+
[key: string]: string;
|
|
619
|
+
} | null;
|
|
620
|
+
}
|
|
621
|
+
//#endregion
|
|
622
|
+
//#region src/models/endpointOut.d.ts
|
|
623
|
+
interface EndpointOut {
|
|
624
|
+
/** The Endpoint's ID. */
|
|
625
|
+
id: string;
|
|
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;
|
|
645
|
+
}
|
|
646
|
+
//#endregion
|
|
647
|
+
//#region src/models/endpointPatch.d.ts
|
|
648
|
+
interface EndpointPatch {
|
|
649
|
+
description?: string;
|
|
650
|
+
/**
|
|
651
|
+
* Maximum messages per second to send to this endpoint.
|
|
652
|
+
*
|
|
653
|
+
* Outgoing messages will be throttled to this rate.
|
|
654
|
+
*/
|
|
655
|
+
throttleRate?: number | null;
|
|
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 {
|
|
669
|
+
/**
|
|
670
|
+
* The endpoint's verification secret.
|
|
671
|
+
*
|
|
672
|
+
* Format: `base64` encoded random bytes optionally prefixed with `whsec_`.
|
|
673
|
+
* It is recommended to not set this and let the server generate the secret.
|
|
674
|
+
*/
|
|
675
|
+
key: string;
|
|
676
|
+
}
|
|
677
|
+
//#endregion
|
|
678
|
+
//#region src/models/endpointSecretRotateIn.d.ts
|
|
679
|
+
interface EndpointSecretRotateIn {
|
|
680
|
+
/**
|
|
681
|
+
* The endpoint's verification secret.
|
|
682
|
+
*
|
|
683
|
+
* Format: `base64` encoded random bytes optionally prefixed with `whsec_`.
|
|
684
|
+
* It is recommended to not set this and let the server generate the secret.
|
|
685
|
+
*/
|
|
686
|
+
key?: string | null;
|
|
687
|
+
/**
|
|
688
|
+
* How long the old secret will be valid for, in seconds.
|
|
689
|
+
*
|
|
690
|
+
* Valid values are between 0 (immediate expiry) and 7 days. The default is 24 hours.
|
|
691
|
+
*/
|
|
692
|
+
gracePeriodSeconds?: number | null;
|
|
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;
|
|
702
|
+
}
|
|
703
|
+
//#endregion
|
|
704
|
+
//#region src/models/endpointTransformationIn.d.ts
|
|
705
|
+
interface EndpointTransformationIn {
|
|
706
|
+
code?: string | null;
|
|
707
|
+
enabled?: boolean;
|
|
708
|
+
}
|
|
709
|
+
//#endregion
|
|
710
|
+
//#region src/models/endpointUpsertIn.d.ts
|
|
711
|
+
interface EndpointUpsertIn {
|
|
712
|
+
url: string;
|
|
713
|
+
description?: string;
|
|
714
|
+
/**
|
|
715
|
+
* Maximum messages per second to send to this endpoint.
|
|
716
|
+
*
|
|
717
|
+
* Outgoing messages will be throttled to this rate.
|
|
718
|
+
*/
|
|
719
|
+
throttleRate?: number | null;
|
|
720
|
+
/** Optional unique identifier for the endpoint. */
|
|
721
|
+
uid?: string | null;
|
|
722
|
+
disabled?: boolean;
|
|
723
|
+
eventTypes?: string[] | null;
|
|
724
|
+
/** List of message channels this endpoint listens to (omit for all). */
|
|
725
|
+
channels?: string[] | null;
|
|
726
|
+
metadata?: {
|
|
727
|
+
[key: string]: string;
|
|
728
|
+
};
|
|
729
|
+
}
|
|
730
|
+
//#endregion
|
|
731
|
+
//#region src/models/eventExampleIn.d.ts
|
|
732
|
+
interface EventExampleIn {
|
|
733
|
+
/** The event type's name */
|
|
734
|
+
eventType: string;
|
|
735
|
+
/**
|
|
736
|
+
* If the event type schema contains an array of examples, chooses which one to send.
|
|
737
|
+
*
|
|
738
|
+
* Defaults to the first example. Ignored if the schema doesn't contain an array of examples.
|
|
739
|
+
*/
|
|
740
|
+
exampleIndex?: number;
|
|
741
|
+
}
|
|
742
|
+
//#endregion
|
|
743
|
+
//#region src/models/listResponseEndpointOut.d.ts
|
|
744
|
+
interface ListResponseEndpointOut {
|
|
745
|
+
data: EndpointOut[];
|
|
746
|
+
iterator: string | null;
|
|
747
|
+
prevIterator?: string | null;
|
|
748
|
+
done: boolean;
|
|
749
|
+
}
|
|
750
|
+
//#endregion
|
|
751
|
+
//#region src/models/messageOut.d.ts
|
|
752
|
+
interface MessageOut {
|
|
753
|
+
/** Optional unique identifier for the message */
|
|
754
|
+
eventId?: string | null;
|
|
755
|
+
/** The event type's name */
|
|
756
|
+
eventType: string;
|
|
757
|
+
payload: any;
|
|
758
|
+
/** List of free-form identifiers that endpoints can filter by */
|
|
759
|
+
channels?: string[] | null;
|
|
760
|
+
/** The Message's ID. */
|
|
761
|
+
id: string;
|
|
762
|
+
timestamp: Date;
|
|
763
|
+
tags?: string[] | null;
|
|
764
|
+
deliverAt?: Date | null;
|
|
765
|
+
}
|
|
766
|
+
//#endregion
|
|
767
|
+
//#region src/models/recoverIn.d.ts
|
|
768
|
+
interface RecoverIn {
|
|
769
|
+
since: Date;
|
|
770
|
+
until?: Date | null;
|
|
771
|
+
}
|
|
772
|
+
//#endregion
|
|
773
|
+
//#region src/models/recoverOut.d.ts
|
|
774
|
+
interface RecoverOut {
|
|
775
|
+
/** The QueueBackgroundTask's ID. */
|
|
776
|
+
id: string;
|
|
777
|
+
status: BackgroundTaskStatus;
|
|
778
|
+
task: BackgroundTaskType;
|
|
779
|
+
updatedAt: Date;
|
|
780
|
+
}
|
|
781
|
+
//#endregion
|
|
782
|
+
//#region src/models/replayIn.d.ts
|
|
783
|
+
interface ReplayIn {
|
|
784
|
+
since: Date;
|
|
785
|
+
until?: Date | null;
|
|
786
|
+
}
|
|
787
|
+
//#endregion
|
|
788
|
+
//#region src/models/replayOut.d.ts
|
|
789
|
+
interface ReplayOut {
|
|
790
|
+
/** The QueueBackgroundTask's ID. */
|
|
791
|
+
id: string;
|
|
792
|
+
status: BackgroundTaskStatus;
|
|
793
|
+
task: BackgroundTaskType;
|
|
794
|
+
updatedAt: Date;
|
|
795
|
+
}
|
|
796
|
+
//#endregion
|
|
797
|
+
//#region src/models/endpointTransformationOut.d.ts
|
|
798
|
+
interface EndpointTransformationOut {
|
|
799
|
+
code?: string | null;
|
|
800
|
+
enabled?: boolean;
|
|
801
|
+
variables?: {
|
|
802
|
+
[key: string]: string;
|
|
803
|
+
} | null;
|
|
804
|
+
updatedAt?: Date | null;
|
|
805
|
+
}
|
|
806
|
+
//#endregion
|
|
807
|
+
//#region src/models/endpointTransformationPatch.d.ts
|
|
808
|
+
interface EndpointTransformationPatch {
|
|
809
|
+
code?: string | null;
|
|
810
|
+
enabled?: boolean;
|
|
811
|
+
variables?: {
|
|
812
|
+
[key: string]: string;
|
|
813
|
+
} | null;
|
|
814
|
+
}
|
|
815
|
+
//#endregion
|
|
816
|
+
//#region src/api/endpointTransformation.d.ts
|
|
817
|
+
declare class EndpointTransformation {
|
|
818
|
+
private readonly requestCtx;
|
|
819
|
+
constructor(requestCtx: SvixRequestContext);
|
|
820
|
+
/** Get the transformation code associated with this endpoint. */
|
|
821
|
+
get(appId: string, endpointId: string): Promise<EndpointTransformationOut>;
|
|
822
|
+
/** Set or unset the transformation code associated with this endpoint. */
|
|
823
|
+
patch(appId: string, endpointId: string, endpointTransformationPatch: EndpointTransformationPatch): Promise<void>;
|
|
824
|
+
}
|
|
825
|
+
//#endregion
|
|
826
|
+
//#region src/api/endpoint.d.ts
|
|
827
|
+
interface EndpointListOptions {
|
|
828
|
+
/** Limit the number of returned items */
|
|
829
|
+
limit?: number;
|
|
830
|
+
/** The iterator returned from a prior invocation */
|
|
831
|
+
iterator?: string | null;
|
|
832
|
+
/** The sorting order of the returned items */
|
|
833
|
+
order?: Ordering;
|
|
834
|
+
}
|
|
835
|
+
interface EndpointCreateOptions {
|
|
836
|
+
idempotencyKey?: string;
|
|
837
|
+
}
|
|
838
|
+
interface EndpointRotateSecretOptions {
|
|
839
|
+
idempotencyKey?: string;
|
|
840
|
+
}
|
|
841
|
+
interface EndpointReplayMissingOptions {
|
|
842
|
+
idempotencyKey?: string;
|
|
843
|
+
}
|
|
844
|
+
interface EndpointBulkReplayOptions {
|
|
845
|
+
idempotencyKey?: string;
|
|
846
|
+
}
|
|
847
|
+
interface EndpointGetStatsOptions {
|
|
848
|
+
/** Filter the range to data starting from this date. */
|
|
849
|
+
since?: Date | null;
|
|
850
|
+
/** Filter the range to data ending by this date. */
|
|
851
|
+
until?: Date | null;
|
|
852
|
+
}
|
|
853
|
+
interface EndpointRecoverOptions {
|
|
854
|
+
idempotencyKey?: string;
|
|
855
|
+
}
|
|
856
|
+
interface EndpointSendExampleOptions {
|
|
857
|
+
idempotencyKey?: string;
|
|
858
|
+
}
|
|
859
|
+
declare class Endpoint {
|
|
860
|
+
private readonly requestCtx;
|
|
861
|
+
constructor(requestCtx: SvixRequestContext);
|
|
862
|
+
get transformation(): EndpointTransformation;
|
|
863
|
+
/** List the application's endpoints. */
|
|
864
|
+
list(appId: string, options?: EndpointListOptions): Promise<ListResponseEndpointOut>;
|
|
865
|
+
/**
|
|
866
|
+
* Create a new endpoint for the application.
|
|
867
|
+
*
|
|
868
|
+
* When `secret` is `null` the secret is automatically generated (recommended).
|
|
869
|
+
*/
|
|
870
|
+
create(appId: string, endpointIn: EndpointIn, options?: EndpointCreateOptions): Promise<EndpointOut>;
|
|
871
|
+
/** Get an endpoint. */
|
|
872
|
+
get(appId: string, endpointId: string): Promise<EndpointOut>;
|
|
873
|
+
/** Create or update an endpoint. */
|
|
874
|
+
upsert(appId: string, endpointId: string, endpointUpsertIn: EndpointUpsertIn): Promise<EndpointOut>;
|
|
875
|
+
/** Delete an endpoint. */
|
|
876
|
+
delete(appId: string, endpointId: string): Promise<void>;
|
|
877
|
+
/** Partially update an endpoint. */
|
|
878
|
+
patch(appId: string, endpointId: string, endpointPatch: EndpointPatch): Promise<EndpointOut>;
|
|
879
|
+
/**
|
|
880
|
+
* Get the endpoint's signing secret.
|
|
881
|
+
*
|
|
882
|
+
* This is used to verify the authenticity of the webhook.
|
|
883
|
+
* For more information please refer to [the consuming webhooks docs](https://docs.svix.com/consuming-webhooks/).
|
|
884
|
+
*/
|
|
885
|
+
getSecret(appId: string, endpointId: string): Promise<EndpointSecretOut>;
|
|
886
|
+
/**
|
|
887
|
+
* Rotates the endpoint's signing secret.
|
|
888
|
+
*
|
|
889
|
+
* The previous secret will remain valid for the specified grace period (default 24 hours).
|
|
890
|
+
*/
|
|
891
|
+
rotateSecret(appId: string, endpointId: string, endpointSecretRotateIn?: EndpointSecretRotateIn, options?: EndpointRotateSecretOptions): Promise<void>;
|
|
892
|
+
/** Get the additional headers to be sent with the webhook. */
|
|
893
|
+
getHeaders(appId: string, endpointId: string): Promise<EndpointHeadersOut>;
|
|
894
|
+
/** Set the additional headers to be sent with the webhook. */
|
|
895
|
+
setHeaders(appId: string, endpointId: string, endpointHeadersIn: EndpointHeadersIn): Promise<void>;
|
|
896
|
+
/** Partially set the additional headers to be sent with the webhook. */
|
|
897
|
+
patchHeaders(appId: string, endpointId: string, endpointHeadersPatchIn: EndpointHeadersPatchIn): Promise<void>;
|
|
898
|
+
/**
|
|
899
|
+
* Replays messages to the endpoint.
|
|
900
|
+
*
|
|
901
|
+
* Only messages that were created after `since` will be sent.
|
|
902
|
+
* Messages that were previously sent to the endpoint are not resent.
|
|
903
|
+
*
|
|
904
|
+
* A completed task will return a payload like the following:
|
|
905
|
+
* ```json
|
|
906
|
+
* {
|
|
907
|
+
* "id": "qtask_33qen93MNuelBAq1T9G7eHLJRsF",
|
|
908
|
+
* "status": "finished",
|
|
909
|
+
* "task": "endpoint.replay",
|
|
910
|
+
* "data": {
|
|
911
|
+
* "messagesSent": 2
|
|
912
|
+
* }
|
|
913
|
+
* }
|
|
914
|
+
* ```
|
|
915
|
+
*/
|
|
916
|
+
replayMissing(appId: string, endpointId: string, replayIn: ReplayIn, options?: EndpointReplayMissingOptions): Promise<ReplayOut>;
|
|
917
|
+
/**
|
|
918
|
+
* Bulk replay messages sent to the endpoint.
|
|
919
|
+
*
|
|
920
|
+
* Only messages that were created after `since` will be sent.
|
|
921
|
+
* This will replay both successful, and failed messages
|
|
922
|
+
*
|
|
923
|
+
* A completed task will return a payload like the following:
|
|
924
|
+
* ```json
|
|
925
|
+
* {
|
|
926
|
+
* "id": "qtask_33qen93MNuelBAq1T9G7eHLJRsF",
|
|
927
|
+
* "status": "finished",
|
|
928
|
+
* "task": "endpoint.bulk-replay",
|
|
929
|
+
* "data": {
|
|
930
|
+
* "messagesSent": 2
|
|
931
|
+
* }
|
|
932
|
+
* }
|
|
933
|
+
* ```
|
|
934
|
+
*/
|
|
935
|
+
bulkReplay(appId: string, endpointId: string, bulkReplayIn: BulkReplayIn, options?: EndpointBulkReplayOptions): Promise<ReplayOut>;
|
|
936
|
+
/** Get basic statistics for the endpoint. */
|
|
937
|
+
getStats(appId: string, endpointId: string, options?: EndpointGetStatsOptions): Promise<EndpointStats>;
|
|
938
|
+
/**
|
|
939
|
+
* Resend all failed messages since a given time.
|
|
940
|
+
*
|
|
941
|
+
* Messages that were sent successfully, even if failed initially, are not resent.
|
|
942
|
+
*
|
|
943
|
+
* A completed task will return a payload like the following:
|
|
944
|
+
* ```json
|
|
945
|
+
* {
|
|
946
|
+
* "id": "qtask_33qen93MNuelBAq1T9G7eHLJRsF",
|
|
947
|
+
* "status": "finished",
|
|
948
|
+
* "task": "endpoint.recover",
|
|
949
|
+
* "data": {
|
|
950
|
+
* "messagesSent": 2
|
|
951
|
+
* }
|
|
952
|
+
* }
|
|
953
|
+
* ```
|
|
954
|
+
*/
|
|
955
|
+
recover(appId: string, endpointId: string, recoverIn: RecoverIn, options?: EndpointRecoverOptions): Promise<RecoverOut>;
|
|
956
|
+
/** Send an example message for an event. */
|
|
957
|
+
sendExample(appId: string, endpointId: string, eventExampleIn: EventExampleIn, options?: EndpointSendExampleOptions): Promise<MessageOut>;
|
|
958
|
+
/**
|
|
959
|
+
* This operation was renamed to `set-transformation`.
|
|
960
|
+
*
|
|
961
|
+
* @deprecated
|
|
962
|
+
*/
|
|
963
|
+
transformationPartialUpdate(appId: string, endpointId: string, endpointTransformationIn?: EndpointTransformationIn): Promise<void>;
|
|
964
|
+
}
|
|
965
|
+
//#endregion
|
|
966
|
+
//#region src/models/eventTypeIn.d.ts
|
|
967
|
+
interface EventTypeIn {
|
|
968
|
+
/** The event type's name */
|
|
969
|
+
name: string;
|
|
970
|
+
description: string;
|
|
971
|
+
archived?: boolean;
|
|
972
|
+
deprecated?: boolean;
|
|
973
|
+
/** The schema for the event type for a specific version as a JSON schema. */
|
|
974
|
+
schemas?: any | null;
|
|
975
|
+
/** The event type group's name */
|
|
976
|
+
groupName?: string | null;
|
|
977
|
+
featureFlags?: string[] | null;
|
|
978
|
+
}
|
|
979
|
+
//#endregion
|
|
980
|
+
//#region src/models/environmentIn.d.ts
|
|
981
|
+
interface EnvironmentIn {
|
|
982
|
+
eventTypes?: EventTypeIn[] | null;
|
|
983
|
+
settings?: any | null;
|
|
984
|
+
connectors?: ConnectorIn[] | null;
|
|
985
|
+
}
|
|
986
|
+
//#endregion
|
|
987
|
+
//#region src/models/eventTypeOut.d.ts
|
|
988
|
+
interface EventTypeOut {
|
|
989
|
+
/** The event type's name */
|
|
990
|
+
name: string;
|
|
991
|
+
description: string;
|
|
992
|
+
archived?: boolean;
|
|
993
|
+
deprecated: boolean;
|
|
994
|
+
/** The schema for the event type for a specific version as a JSON schema. */
|
|
995
|
+
schemas?: any | null;
|
|
996
|
+
createdAt: Date;
|
|
997
|
+
updatedAt: Date;
|
|
998
|
+
/** The event type group's name */
|
|
999
|
+
groupName?: string | null;
|
|
1000
|
+
featureFlags?: string[] | null;
|
|
1001
|
+
featureFlag?: string | null;
|
|
1002
|
+
}
|
|
1003
|
+
//#endregion
|
|
1004
|
+
//#region src/models/environmentOut.d.ts
|
|
1005
|
+
interface EnvironmentOut {
|
|
1006
|
+
version?: number;
|
|
1007
|
+
createdAt: Date;
|
|
1008
|
+
eventTypes: EventTypeOut[];
|
|
1009
|
+
settings: any | null;
|
|
1010
|
+
connectors: ConnectorOut[];
|
|
1011
|
+
}
|
|
1012
|
+
//#endregion
|
|
1013
|
+
//#region src/api/environment.d.ts
|
|
1014
|
+
interface EnvironmentExportOptions {
|
|
1015
|
+
idempotencyKey?: string;
|
|
1016
|
+
}
|
|
1017
|
+
interface EnvironmentImportOptions {
|
|
1018
|
+
idempotencyKey?: string;
|
|
1019
|
+
}
|
|
1020
|
+
declare class Environment {
|
|
1021
|
+
private readonly requestCtx;
|
|
1022
|
+
constructor(requestCtx: SvixRequestContext);
|
|
1023
|
+
/**
|
|
1024
|
+
* Download a JSON file containing all org-settings and event types.
|
|
1025
|
+
*
|
|
1026
|
+
* Note that the schema for [`EnvironmentOut`] is subject to change. The fields
|
|
1027
|
+
* herein are provided for convenience but should be treated as JSON blobs.
|
|
1028
|
+
*/
|
|
1029
|
+
export(options?: EnvironmentExportOptions): Promise<EnvironmentOut>;
|
|
1030
|
+
/**
|
|
1031
|
+
* Import a configuration into the active organization.
|
|
1032
|
+
*
|
|
1033
|
+
* It doesn't delete anything, only adds / updates what was passed to it.
|
|
1034
|
+
*
|
|
1035
|
+
* Note that the schema for [`EnvironmentIn`] is subject to change. The fields
|
|
1036
|
+
* herein are provided for convenience but should be treated as JSON blobs.
|
|
1037
|
+
*/
|
|
1038
|
+
import(environmentIn?: EnvironmentIn, options?: EnvironmentImportOptions): Promise<void>;
|
|
1039
|
+
}
|
|
1040
|
+
//#endregion
|
|
1041
|
+
//#region src/models/eventTypeImportOpenApiIn.d.ts
|
|
1042
|
+
/**
|
|
1043
|
+
* Import a list of event types from webhooks defined in an OpenAPI spec.
|
|
1044
|
+
*
|
|
1045
|
+
* The OpenAPI spec can be specified as either `spec` given the spec as a JSON object, or as `specRaw` (a `string`) which will be parsed as YAML or JSON by the server. Sending neither or both is invalid, resulting in a `400` **Bad Request**.
|
|
1046
|
+
*/
|
|
1047
|
+
interface EventTypeImportOpenApiIn {
|
|
1048
|
+
/** If `true`, return the event types that would be modified without actually modifying them. */
|
|
1049
|
+
dryRun?: boolean;
|
|
1050
|
+
/** If `true`, all existing event types that are not in the spec will be archived. */
|
|
1051
|
+
replaceAll?: boolean;
|
|
1052
|
+
/** A pre-parsed JSON spec. */
|
|
1053
|
+
spec?: any | null;
|
|
1054
|
+
/** A string, parsed by the server as YAML or JSON. */
|
|
1055
|
+
specRaw?: string | null;
|
|
1056
|
+
}
|
|
1057
|
+
//#endregion
|
|
1058
|
+
//#region src/models/eventTypeFromOpenApi.d.ts
|
|
1059
|
+
interface EventTypeFromOpenApi {
|
|
1060
|
+
/** The event type's name */
|
|
1061
|
+
name: string;
|
|
1062
|
+
description: string;
|
|
1063
|
+
schemas?: any | null;
|
|
1064
|
+
deprecated: boolean;
|
|
1065
|
+
/** The event type group's name */
|
|
1066
|
+
groupName?: string | null;
|
|
1067
|
+
featureFlags?: string[] | null;
|
|
1068
|
+
}
|
|
1069
|
+
//#endregion
|
|
1070
|
+
//#region src/models/eventTypeImportOpenApiOutData.d.ts
|
|
1071
|
+
interface EventTypeImportOpenApiOutData {
|
|
1072
|
+
modified: string[];
|
|
1073
|
+
toModify?: EventTypeFromOpenApi[] | null;
|
|
1074
|
+
}
|
|
1075
|
+
//#endregion
|
|
1076
|
+
//#region src/models/eventTypeImportOpenApiOut.d.ts
|
|
1077
|
+
interface EventTypeImportOpenApiOut {
|
|
1078
|
+
data: EventTypeImportOpenApiOutData;
|
|
1079
|
+
}
|
|
1080
|
+
//#endregion
|
|
1081
|
+
//#region src/models/eventTypePatch.d.ts
|
|
1082
|
+
interface EventTypePatch {
|
|
1083
|
+
description?: string;
|
|
1084
|
+
archived?: boolean;
|
|
1085
|
+
deprecated?: boolean;
|
|
1086
|
+
schemas?: any | null;
|
|
1087
|
+
featureFlags?: string[] | null;
|
|
1088
|
+
/** The event type group's name */
|
|
1089
|
+
groupName?: string | null;
|
|
1090
|
+
}
|
|
1091
|
+
//#endregion
|
|
1092
|
+
//#region src/models/eventTypeUpsertIn.d.ts
|
|
1093
|
+
interface EventTypeUpsertIn {
|
|
1094
|
+
description: string;
|
|
1095
|
+
archived?: boolean;
|
|
1096
|
+
deprecated?: boolean;
|
|
1097
|
+
/** The schema for the event type for a specific version as a JSON schema. */
|
|
1098
|
+
schemas?: any | null;
|
|
1099
|
+
featureFlags?: string[] | null;
|
|
1100
|
+
/** The event type group's name */
|
|
1101
|
+
groupName?: string | null;
|
|
1102
|
+
}
|
|
1103
|
+
//#endregion
|
|
1104
|
+
//#region src/models/listResponseEventTypeOut.d.ts
|
|
1105
|
+
interface ListResponseEventTypeOut {
|
|
1106
|
+
data: EventTypeOut[];
|
|
1107
|
+
iterator: string | null;
|
|
1108
|
+
prevIterator?: string | null;
|
|
1109
|
+
done: boolean;
|
|
1110
|
+
}
|
|
1111
|
+
//#endregion
|
|
1112
|
+
//#region src/api/eventType.d.ts
|
|
1113
|
+
interface EventTypeListOptions {
|
|
1114
|
+
/** Limit the number of returned items */
|
|
1115
|
+
limit?: number;
|
|
1116
|
+
/** The iterator returned from a prior invocation */
|
|
1117
|
+
iterator?: string | null;
|
|
1118
|
+
/** The sorting order of the returned items */
|
|
1119
|
+
order?: Ordering;
|
|
1120
|
+
/** When `true` archived (deleted but not expunged) items are included in the response. */
|
|
1121
|
+
includeArchived?: boolean;
|
|
1122
|
+
/** When `true` the full item (including the schema) is included in the response. */
|
|
1123
|
+
withContent?: boolean;
|
|
1124
|
+
}
|
|
1125
|
+
interface EventTypeCreateOptions {
|
|
1126
|
+
idempotencyKey?: string;
|
|
1127
|
+
}
|
|
1128
|
+
interface EventTypeImportOpenapiOptions {
|
|
1129
|
+
idempotencyKey?: string;
|
|
1130
|
+
}
|
|
1131
|
+
interface EventTypeDeleteOptions {
|
|
1132
|
+
/** By default event types are archived when "deleted". Passing this to `true` deletes them entirely. */
|
|
1133
|
+
expunge?: boolean;
|
|
1134
|
+
}
|
|
1135
|
+
declare class EventType {
|
|
1136
|
+
private readonly requestCtx;
|
|
1137
|
+
constructor(requestCtx: SvixRequestContext);
|
|
1138
|
+
/** Return the list of event types. */
|
|
1139
|
+
list(options?: EventTypeListOptions): Promise<ListResponseEventTypeOut>;
|
|
1140
|
+
/**
|
|
1141
|
+
* Create new or unarchive existing event type.
|
|
1142
|
+
*
|
|
1143
|
+
* Unarchiving an event type will allow endpoints to filter on it and messages to be sent with it.
|
|
1144
|
+
* Endpoints filtering on the event type before archival will continue to filter on it.
|
|
1145
|
+
* This operation does not preserve the description and schemas.
|
|
1146
|
+
*/
|
|
1147
|
+
create(eventTypeIn: EventTypeIn, options?: EventTypeCreateOptions): Promise<EventTypeOut>;
|
|
1148
|
+
/**
|
|
1149
|
+
* Given an OpenAPI spec, create new or update existing event types.
|
|
1150
|
+
*
|
|
1151
|
+
* If an existing `archived` event type is updated, it will be unarchived.
|
|
1152
|
+
* The importer will convert all webhooks found in the either the `webhooks` or `x-webhooks`
|
|
1153
|
+
* top-level.
|
|
1154
|
+
*/
|
|
1155
|
+
importOpenapi(eventTypeImportOpenApiIn?: EventTypeImportOpenApiIn, options?: EventTypeImportOpenapiOptions): Promise<EventTypeImportOpenApiOut>;
|
|
1156
|
+
/** Get an event type. */
|
|
1157
|
+
get(eventTypeName: string): Promise<EventTypeOut>;
|
|
1158
|
+
/** Create or update an event type. */
|
|
1159
|
+
upsert(eventTypeName: string, eventTypeUpsertIn: EventTypeUpsertIn): Promise<EventTypeOut>;
|
|
1160
|
+
/**
|
|
1161
|
+
* Archive an event type.
|
|
1162
|
+
*
|
|
1163
|
+
* Endpoints already configured to filter on an event type will continue to do so after archival.
|
|
1164
|
+
* However, new messages can not be sent with it and endpoints can not filter on it.
|
|
1165
|
+
* An event type can be unarchived with the
|
|
1166
|
+
* [create operation](#operation/create_event_type_api_v1_event_type__post).
|
|
1167
|
+
*/
|
|
1168
|
+
delete(eventTypeName: string, options?: EventTypeDeleteOptions): Promise<void>;
|
|
1169
|
+
/** Partially update an event type. */
|
|
1170
|
+
patch(eventTypeName: string, eventTypePatch: EventTypePatch): Promise<EventTypeOut>;
|
|
1171
|
+
}
|
|
1172
|
+
//#endregion
|
|
1173
|
+
//#region src/api/health.d.ts
|
|
1174
|
+
declare class Health {
|
|
1175
|
+
private readonly requestCtx;
|
|
1176
|
+
constructor(requestCtx: SvixRequestContext);
|
|
1177
|
+
/** Verify the API server is up and running. */
|
|
1178
|
+
get(): Promise<void>;
|
|
1179
|
+
}
|
|
1180
|
+
//#endregion
|
|
1181
|
+
//#region src/models/ingestSourceConsumerPortalAccessIn.d.ts
|
|
1182
|
+
interface IngestSourceConsumerPortalAccessIn {
|
|
1183
|
+
/**
|
|
1184
|
+
* How long the token will be valid for, in seconds.
|
|
1185
|
+
*
|
|
1186
|
+
* Valid values are between 1 hour and 7 days. The default is 7 days.
|
|
1187
|
+
*/
|
|
1188
|
+
expiry?: number | null;
|
|
1189
|
+
/** Whether the app portal should be in read-only mode. */
|
|
1190
|
+
readOnly?: boolean | null;
|
|
1191
|
+
}
|
|
1192
|
+
//#endregion
|
|
1193
|
+
//#region src/api/ingestAuthentication.d.ts
|
|
1194
|
+
interface IngestAuthenticationConsumerPortalAccessOptions {
|
|
1195
|
+
idempotencyKey?: string;
|
|
1196
|
+
}
|
|
1197
|
+
declare class IngestAuthentication {
|
|
1198
|
+
private readonly requestCtx;
|
|
1199
|
+
constructor(requestCtx: SvixRequestContext);
|
|
1200
|
+
/** Get access to the Ingest Source Consumer Portal. */
|
|
1201
|
+
consumerPortalAccess(sourceId: string, ingestSourceConsumerPortalAccessIn?: IngestSourceConsumerPortalAccessIn, options?: IngestAuthenticationConsumerPortalAccessOptions): Promise<AppPortalAccessOut>;
|
|
1202
|
+
}
|
|
1203
|
+
//#endregion
|
|
1204
|
+
//#region src/models/ingestEndpointHeadersIn.d.ts
|
|
1205
|
+
interface IngestEndpointHeadersIn {
|
|
1206
|
+
headers: {
|
|
1207
|
+
[key: string]: string;
|
|
1208
|
+
};
|
|
1209
|
+
}
|
|
1210
|
+
//#endregion
|
|
1211
|
+
//#region src/models/ingestEndpointHeadersOut.d.ts
|
|
1212
|
+
interface IngestEndpointHeadersOut {
|
|
1213
|
+
headers: {
|
|
1214
|
+
[key: string]: string;
|
|
1215
|
+
};
|
|
1216
|
+
sensitive: string[];
|
|
1217
|
+
}
|
|
1218
|
+
//#endregion
|
|
1219
|
+
//#region src/models/ingestEndpointIn.d.ts
|
|
1220
|
+
interface IngestEndpointIn {
|
|
1221
|
+
url: string;
|
|
1222
|
+
description?: string;
|
|
1223
|
+
/**
|
|
1224
|
+
* Maximum messages per second to send to this endpoint.
|
|
1225
|
+
*
|
|
1226
|
+
* Outgoing messages will be throttled to this rate.
|
|
1227
|
+
*/
|
|
1228
|
+
throttleRate?: number | null;
|
|
1229
|
+
/** Optional unique identifier for the endpoint. */
|
|
1230
|
+
uid?: string | null;
|
|
1231
|
+
disabled?: boolean;
|
|
1232
|
+
/**
|
|
1233
|
+
* The endpoint's verification secret.
|
|
1234
|
+
*
|
|
1235
|
+
* Format: `base64` encoded random bytes optionally prefixed with `whsec_`.
|
|
1236
|
+
* It is recommended to not set this and let the server generate the secret.
|
|
1237
|
+
*/
|
|
1238
|
+
secret?: string | null;
|
|
1239
|
+
metadata?: {
|
|
1240
|
+
[key: string]: string;
|
|
1241
|
+
};
|
|
1242
|
+
headers?: {
|
|
1243
|
+
[key: string]: string;
|
|
1244
|
+
} | null;
|
|
1245
|
+
}
|
|
1246
|
+
//#endregion
|
|
1247
|
+
//#region src/models/ingestEndpointOut.d.ts
|
|
1248
|
+
interface IngestEndpointOut {
|
|
1249
|
+
/** The Endpoint's ID. */
|
|
1250
|
+
id: string;
|
|
1251
|
+
url: string;
|
|
1252
|
+
description: string;
|
|
1253
|
+
/**
|
|
1254
|
+
* Maximum messages per second to send to this endpoint.
|
|
1255
|
+
*
|
|
1256
|
+
* Outgoing messages will be throttled to this rate.
|
|
1257
|
+
*/
|
|
1258
|
+
throttleRate?: number | null;
|
|
1259
|
+
/** Optional unique identifier for the endpoint. */
|
|
1260
|
+
uid?: string | null;
|
|
1261
|
+
disabled?: boolean;
|
|
1262
|
+
createdAt: Date;
|
|
1263
|
+
updatedAt: Date;
|
|
1264
|
+
metadata: {
|
|
1265
|
+
[key: string]: string;
|
|
1266
|
+
};
|
|
1267
|
+
}
|
|
1268
|
+
//#endregion
|
|
1269
|
+
//#region src/models/ingestEndpointSecretIn.d.ts
|
|
1270
|
+
interface IngestEndpointSecretIn {
|
|
1271
|
+
/**
|
|
1272
|
+
* The endpoint's verification secret.
|
|
1273
|
+
*
|
|
1274
|
+
* Format: `base64` encoded random bytes optionally prefixed with `whsec_`.
|
|
1275
|
+
* It is recommended to not set this and let the server generate the secret.
|
|
1276
|
+
*/
|
|
1277
|
+
key?: string | null;
|
|
1278
|
+
/**
|
|
1279
|
+
* How long the old secret will be valid for, in seconds.
|
|
1280
|
+
*
|
|
1281
|
+
* Valid values are between 0 (immediate expiry) and 7 days. The default is 24 hours.
|
|
1282
|
+
*/
|
|
1283
|
+
gracePeriodSeconds?: number | null;
|
|
1284
|
+
}
|
|
1285
|
+
//#endregion
|
|
1286
|
+
//#region src/models/ingestEndpointSecretOut.d.ts
|
|
1287
|
+
interface IngestEndpointSecretOut {
|
|
1288
|
+
/**
|
|
1289
|
+
* The endpoint's verification secret.
|
|
1290
|
+
*
|
|
1291
|
+
* Format: `base64` encoded random bytes optionally prefixed with `whsec_`.
|
|
1292
|
+
* It is recommended to not set this and let the server generate the secret.
|
|
1293
|
+
*/
|
|
1294
|
+
key: string;
|
|
1295
|
+
}
|
|
1296
|
+
//#endregion
|
|
1297
|
+
//#region src/models/ingestEndpointUpsertIn.d.ts
|
|
1298
|
+
interface IngestEndpointUpsertIn {
|
|
1299
|
+
url: string;
|
|
1300
|
+
description?: string;
|
|
1301
|
+
/**
|
|
1302
|
+
* Maximum messages per second to send to this endpoint.
|
|
1303
|
+
*
|
|
1304
|
+
* Outgoing messages will be throttled to this rate.
|
|
1305
|
+
*/
|
|
1306
|
+
throttleRate?: number | null;
|
|
1307
|
+
/** Optional unique identifier for the endpoint. */
|
|
1308
|
+
uid?: string | null;
|
|
1309
|
+
disabled?: boolean;
|
|
1310
|
+
metadata?: {
|
|
1311
|
+
[key: string]: string;
|
|
1312
|
+
};
|
|
1313
|
+
}
|
|
1314
|
+
//#endregion
|
|
1315
|
+
//#region src/models/listResponseIngestEndpointOut.d.ts
|
|
1316
|
+
interface ListResponseIngestEndpointOut {
|
|
1317
|
+
data: IngestEndpointOut[];
|
|
1318
|
+
iterator: string | null;
|
|
1319
|
+
prevIterator?: string | null;
|
|
1320
|
+
done: boolean;
|
|
1321
|
+
}
|
|
1322
|
+
//#endregion
|
|
1323
|
+
//#region src/models/ingestEndpointTransformationOut.d.ts
|
|
1324
|
+
interface IngestEndpointTransformationOut {
|
|
1325
|
+
code?: string | null;
|
|
1326
|
+
enabled?: boolean;
|
|
1327
|
+
variables?: {
|
|
1328
|
+
[key: string]: string;
|
|
1329
|
+
} | null;
|
|
1330
|
+
}
|
|
1331
|
+
//#endregion
|
|
1332
|
+
//#region src/models/ingestEndpointTransformationPatch.d.ts
|
|
1333
|
+
interface IngestEndpointTransformationPatch {
|
|
1334
|
+
code?: string | null;
|
|
1335
|
+
enabled?: boolean;
|
|
1336
|
+
variables?: {
|
|
1337
|
+
[key: string]: string;
|
|
1338
|
+
} | null;
|
|
1339
|
+
}
|
|
1340
|
+
//#endregion
|
|
1341
|
+
//#region src/api/ingestEndpointTransformation.d.ts
|
|
1342
|
+
declare class IngestEndpointTransformation {
|
|
1343
|
+
private readonly requestCtx;
|
|
1344
|
+
constructor(requestCtx: SvixRequestContext);
|
|
1345
|
+
/** Get the transformation code associated with this ingest endpoint. */
|
|
1346
|
+
get(sourceId: string, endpointId: string): Promise<IngestEndpointTransformationOut>;
|
|
1347
|
+
/** Set or unset the transformation code associated with this ingest endpoint. */
|
|
1348
|
+
patch(sourceId: string, endpointId: string, ingestEndpointTransformationPatch: IngestEndpointTransformationPatch): Promise<void>;
|
|
1349
|
+
}
|
|
1350
|
+
//#endregion
|
|
1351
|
+
//#region src/api/ingestEndpoint.d.ts
|
|
1352
|
+
interface IngestEndpointListOptions {
|
|
1353
|
+
/** Limit the number of returned items */
|
|
1354
|
+
limit?: number;
|
|
1355
|
+
/** The iterator returned from a prior invocation */
|
|
1356
|
+
iterator?: string | null;
|
|
1357
|
+
/** The sorting order of the returned items */
|
|
1358
|
+
order?: Ordering;
|
|
1359
|
+
}
|
|
1360
|
+
interface IngestEndpointCreateOptions {
|
|
1361
|
+
idempotencyKey?: string;
|
|
1362
|
+
}
|
|
1363
|
+
interface IngestEndpointRotateSecretOptions {
|
|
1364
|
+
idempotencyKey?: string;
|
|
1365
|
+
}
|
|
1366
|
+
declare class IngestEndpoint {
|
|
1367
|
+
private readonly requestCtx;
|
|
1368
|
+
constructor(requestCtx: SvixRequestContext);
|
|
1369
|
+
get transformation(): IngestEndpointTransformation;
|
|
1370
|
+
/** List ingest endpoints. */
|
|
1371
|
+
list(sourceId: string, options?: IngestEndpointListOptions): Promise<ListResponseIngestEndpointOut>;
|
|
1372
|
+
/** Create an ingest endpoint. */
|
|
1373
|
+
create(sourceId: string, ingestEndpointIn: IngestEndpointIn, options?: IngestEndpointCreateOptions): Promise<IngestEndpointOut>;
|
|
1374
|
+
/** Get an ingest endpoint. */
|
|
1375
|
+
get(sourceId: string, endpointId: string): Promise<IngestEndpointOut>;
|
|
1376
|
+
/** Create or update an ingest endpoint. */
|
|
1377
|
+
upsert(sourceId: string, endpointId: string, ingestEndpointUpsertIn: IngestEndpointUpsertIn): Promise<IngestEndpointOut>;
|
|
1378
|
+
/** Delete an ingest endpoint. */
|
|
1379
|
+
delete(sourceId: string, endpointId: string): Promise<void>;
|
|
1380
|
+
/**
|
|
1381
|
+
* Get an ingest endpoint's signing secret.
|
|
1382
|
+
*
|
|
1383
|
+
* This is used to verify the authenticity of the webhook.
|
|
1384
|
+
* For more information please refer to [the consuming webhooks docs](https://docs.svix.com/consuming-webhooks/).
|
|
1385
|
+
*/
|
|
1386
|
+
getSecret(sourceId: string, endpointId: string): Promise<IngestEndpointSecretOut>;
|
|
1387
|
+
/**
|
|
1388
|
+
* Rotates an ingest endpoint's signing secret.
|
|
1389
|
+
*
|
|
1390
|
+
* The previous secret will remain valid for the specified grace period (default 24 hours).
|
|
1391
|
+
*/
|
|
1392
|
+
rotateSecret(sourceId: string, endpointId: string, ingestEndpointSecretIn?: IngestEndpointSecretIn, options?: IngestEndpointRotateSecretOptions): Promise<void>;
|
|
1393
|
+
/** Get the additional headers to be sent with the ingest. */
|
|
1394
|
+
getHeaders(sourceId: string, endpointId: string): Promise<IngestEndpointHeadersOut>;
|
|
1395
|
+
/** Set the additional headers to be sent to the endpoint. */
|
|
1396
|
+
setHeaders(sourceId: string, endpointId: string, ingestEndpointHeadersIn: IngestEndpointHeadersIn): Promise<void>;
|
|
1397
|
+
}
|
|
1398
|
+
//#endregion
|
|
1399
|
+
//#region src/models/adobeSignConfig.d.ts
|
|
1400
|
+
interface AdobeSignConfig {
|
|
1401
|
+
clientId: string;
|
|
1402
|
+
}
|
|
1403
|
+
//#endregion
|
|
1404
|
+
//#region src/models/airwallexConfig.d.ts
|
|
1405
|
+
interface AirwallexConfig {
|
|
1406
|
+
secret: string;
|
|
1407
|
+
}
|
|
1408
|
+
//#endregion
|
|
1409
|
+
//#region src/models/checkbookConfig.d.ts
|
|
1410
|
+
interface CheckbookConfig {
|
|
1411
|
+
secret: string;
|
|
1412
|
+
}
|
|
1413
|
+
//#endregion
|
|
1414
|
+
//#region src/models/cronConfig.d.ts
|
|
1415
|
+
interface CronConfig {
|
|
1416
|
+
schedule: string;
|
|
1417
|
+
payload: string;
|
|
1418
|
+
/**
|
|
1419
|
+
* Override the default content-type.
|
|
1420
|
+
*
|
|
1421
|
+
* Recommended if the payload is not JSON.
|
|
1422
|
+
*/
|
|
1423
|
+
contentType?: string | null;
|
|
1424
|
+
}
|
|
1425
|
+
//#endregion
|
|
1426
|
+
//#region src/models/docusignConfig.d.ts
|
|
1427
|
+
interface DocusignConfig {
|
|
1428
|
+
secret?: string | null;
|
|
1429
|
+
}
|
|
1430
|
+
//#endregion
|
|
1431
|
+
//#region src/models/easypostConfig.d.ts
|
|
1432
|
+
interface EasypostConfig {
|
|
1433
|
+
secret?: string | null;
|
|
1434
|
+
}
|
|
1435
|
+
//#endregion
|
|
1436
|
+
//#region src/models/githubConfig.d.ts
|
|
1437
|
+
interface GithubConfig {
|
|
1438
|
+
secret?: string | null;
|
|
1439
|
+
}
|
|
1440
|
+
//#endregion
|
|
1441
|
+
//#region src/models/hubspotConfig.d.ts
|
|
1442
|
+
interface HubspotConfig {
|
|
1443
|
+
secret?: string | null;
|
|
1444
|
+
}
|
|
1445
|
+
//#endregion
|
|
1446
|
+
//#region src/models/metaConfig.d.ts
|
|
1447
|
+
interface MetaConfig {
|
|
1448
|
+
secret: string;
|
|
1449
|
+
verifyToken: string;
|
|
1450
|
+
}
|
|
1451
|
+
//#endregion
|
|
1452
|
+
//#region src/models/nangoConfig.d.ts
|
|
1453
|
+
interface NangoConfig {
|
|
1454
|
+
secret: string;
|
|
1455
|
+
}
|
|
1456
|
+
//#endregion
|
|
1457
|
+
//#region src/models/openClawConfig.d.ts
|
|
1458
|
+
interface OpenClawConfig {
|
|
1459
|
+
secret: string;
|
|
1460
|
+
}
|
|
1461
|
+
//#endregion
|
|
1462
|
+
//#region src/models/orumIoConfig.d.ts
|
|
1463
|
+
interface OrumIoConfig {
|
|
1464
|
+
publicKey: string;
|
|
1465
|
+
}
|
|
1466
|
+
//#endregion
|
|
1467
|
+
//#region src/models/pandaDocConfig.d.ts
|
|
1468
|
+
interface PandaDocConfig {
|
|
1469
|
+
secret: string;
|
|
1470
|
+
}
|
|
1471
|
+
//#endregion
|
|
1472
|
+
//#region src/models/portIoConfig.d.ts
|
|
1473
|
+
interface PortIoConfig {
|
|
1474
|
+
secret: string;
|
|
1475
|
+
}
|
|
1476
|
+
//#endregion
|
|
1477
|
+
//#region src/models/rutterConfig.d.ts
|
|
1478
|
+
interface RutterConfig {
|
|
1479
|
+
secret: string;
|
|
1480
|
+
}
|
|
1481
|
+
//#endregion
|
|
1482
|
+
//#region src/models/segmentConfig.d.ts
|
|
1483
|
+
interface SegmentConfig {
|
|
1484
|
+
secret?: string | null;
|
|
1485
|
+
}
|
|
1486
|
+
//#endregion
|
|
1487
|
+
//#region src/models/shopifyConfig.d.ts
|
|
1488
|
+
interface ShopifyConfig {
|
|
1489
|
+
secret: string;
|
|
1490
|
+
}
|
|
1491
|
+
//#endregion
|
|
1492
|
+
//#region src/models/slackConfig.d.ts
|
|
1493
|
+
interface SlackConfig {
|
|
1494
|
+
secret: string;
|
|
1495
|
+
}
|
|
1496
|
+
//#endregion
|
|
1497
|
+
//#region src/models/stripeConfig.d.ts
|
|
1498
|
+
interface StripeConfig {
|
|
1499
|
+
secret: string;
|
|
1500
|
+
}
|
|
1501
|
+
//#endregion
|
|
1502
|
+
//#region src/models/svixConfig.d.ts
|
|
1503
|
+
interface SvixConfig {
|
|
1504
|
+
secret: string;
|
|
1505
|
+
}
|
|
1506
|
+
//#endregion
|
|
1507
|
+
//#region src/models/tailscaleConfig.d.ts
|
|
1508
|
+
interface TailscaleConfig {
|
|
1509
|
+
/** Shared secret for Tailscale Webhooks */
|
|
1510
|
+
secret: string;
|
|
1511
|
+
/**
|
|
1512
|
+
* Grace period (in seconds) for the timestamp.
|
|
1513
|
+
*
|
|
1514
|
+
* If not passed, timestamp age will not be checked.
|
|
1515
|
+
*/
|
|
1516
|
+
timestampGraceSeconds?: number | null;
|
|
1517
|
+
}
|
|
1518
|
+
//#endregion
|
|
1519
|
+
//#region src/models/telnyxConfig.d.ts
|
|
1520
|
+
interface TelnyxConfig {
|
|
1521
|
+
publicKey: string;
|
|
1522
|
+
}
|
|
1523
|
+
//#endregion
|
|
1524
|
+
//#region src/models/vapiConfig.d.ts
|
|
1525
|
+
interface VapiConfig {
|
|
1526
|
+
secret: string;
|
|
1527
|
+
}
|
|
1528
|
+
//#endregion
|
|
1529
|
+
//#region src/models/veriffConfig.d.ts
|
|
1530
|
+
interface VeriffConfig {
|
|
1531
|
+
secret: string;
|
|
1532
|
+
}
|
|
1533
|
+
//#endregion
|
|
1534
|
+
//#region src/models/vgsConfig.d.ts
|
|
1535
|
+
interface VgsConfig {
|
|
1536
|
+
secret: string;
|
|
1537
|
+
}
|
|
1538
|
+
//#endregion
|
|
1539
|
+
//#region src/models/zoomConfig.d.ts
|
|
1540
|
+
interface ZoomConfig {
|
|
1541
|
+
secret: string;
|
|
1542
|
+
}
|
|
1543
|
+
//#endregion
|
|
1544
|
+
//#region src/models/ingestSourceIn.d.ts
|
|
1545
|
+
interface _IngestSourceInFields {
|
|
1546
|
+
name: string;
|
|
1547
|
+
/** The Source's UID. */
|
|
1548
|
+
uid?: string | null;
|
|
1549
|
+
metadata?: {
|
|
1550
|
+
[key: string]: string;
|
|
1551
|
+
};
|
|
1552
|
+
}
|
|
1553
|
+
interface IngestSourceInGenericWebhookConfig {}
|
|
1554
|
+
interface IngestSourceInGenericWebhook {
|
|
1555
|
+
type: "generic-webhook";
|
|
1556
|
+
config?: IngestSourceInGenericWebhookConfig;
|
|
1557
|
+
}
|
|
1558
|
+
interface IngestSourceInCron {
|
|
1559
|
+
type: "cron";
|
|
1560
|
+
config: CronConfig;
|
|
1561
|
+
}
|
|
1562
|
+
interface IngestSourceInAdobeSign {
|
|
1563
|
+
type: "adobe-sign";
|
|
1564
|
+
config: AdobeSignConfig;
|
|
1565
|
+
}
|
|
1566
|
+
interface IngestSourceInBeehiiv {
|
|
1567
|
+
type: "beehiiv";
|
|
1568
|
+
config: SvixConfig;
|
|
1569
|
+
}
|
|
1570
|
+
interface IngestSourceInBrex {
|
|
1571
|
+
type: "brex";
|
|
1572
|
+
config: SvixConfig;
|
|
1573
|
+
}
|
|
1574
|
+
interface IngestSourceInCheckbook {
|
|
1575
|
+
type: "checkbook";
|
|
1576
|
+
config: CheckbookConfig;
|
|
1577
|
+
}
|
|
1578
|
+
interface IngestSourceInClerk {
|
|
1579
|
+
type: "clerk";
|
|
1580
|
+
config: SvixConfig;
|
|
1581
|
+
}
|
|
1582
|
+
interface IngestSourceInDocusign {
|
|
1583
|
+
type: "docusign";
|
|
1584
|
+
config: DocusignConfig;
|
|
1585
|
+
}
|
|
1586
|
+
interface IngestSourceInEasypost {
|
|
1587
|
+
type: "easypost";
|
|
1588
|
+
config: EasypostConfig;
|
|
1589
|
+
}
|
|
1590
|
+
interface IngestSourceInGithub {
|
|
1591
|
+
type: "github";
|
|
1592
|
+
config: GithubConfig;
|
|
1593
|
+
}
|
|
1594
|
+
interface IngestSourceInGuesty {
|
|
1595
|
+
type: "guesty";
|
|
1596
|
+
config: SvixConfig;
|
|
1597
|
+
}
|
|
1598
|
+
interface IngestSourceInHubspot {
|
|
1599
|
+
type: "hubspot";
|
|
1600
|
+
config: HubspotConfig;
|
|
1601
|
+
}
|
|
1602
|
+
interface IngestSourceInIncidentIo {
|
|
1603
|
+
type: "incident-io";
|
|
1604
|
+
config: SvixConfig;
|
|
1605
|
+
}
|
|
1606
|
+
interface IngestSourceInLithic {
|
|
1607
|
+
type: "lithic";
|
|
1608
|
+
config: SvixConfig;
|
|
1609
|
+
}
|
|
1610
|
+
interface IngestSourceInMeta {
|
|
1611
|
+
type: "meta";
|
|
1612
|
+
config: MetaConfig;
|
|
1613
|
+
}
|
|
1614
|
+
interface IngestSourceInNango {
|
|
1615
|
+
type: "nango";
|
|
1616
|
+
config: NangoConfig;
|
|
1617
|
+
}
|
|
1618
|
+
interface IngestSourceInNash {
|
|
1619
|
+
type: "nash";
|
|
1620
|
+
config: SvixConfig;
|
|
1621
|
+
}
|
|
1622
|
+
interface IngestSourceInOpenclaw {
|
|
1623
|
+
type: "openclaw";
|
|
1624
|
+
config: OpenClawConfig;
|
|
1625
|
+
}
|
|
1626
|
+
interface IngestSourceInOrumIo {
|
|
1627
|
+
type: "orum-io";
|
|
1628
|
+
config: OrumIoConfig;
|
|
1629
|
+
}
|
|
1630
|
+
interface IngestSourceInPandaDoc {
|
|
1631
|
+
type: "panda-doc";
|
|
1632
|
+
config: PandaDocConfig;
|
|
1633
|
+
}
|
|
1634
|
+
interface IngestSourceInPortIo {
|
|
1635
|
+
type: "port-io";
|
|
1636
|
+
config: PortIoConfig;
|
|
1637
|
+
}
|
|
1638
|
+
interface IngestSourceInPleo {
|
|
1639
|
+
type: "pleo";
|
|
1640
|
+
config: SvixConfig;
|
|
1641
|
+
}
|
|
1642
|
+
interface IngestSourceInPsiFi {
|
|
1643
|
+
type: "psi-fi";
|
|
1644
|
+
config: SvixConfig;
|
|
1645
|
+
}
|
|
1646
|
+
interface IngestSourceInReplicate {
|
|
1647
|
+
type: "replicate";
|
|
1648
|
+
config: SvixConfig;
|
|
1649
|
+
}
|
|
1650
|
+
interface IngestSourceInResend {
|
|
1651
|
+
type: "resend";
|
|
1652
|
+
config: SvixConfig;
|
|
1653
|
+
}
|
|
1654
|
+
interface IngestSourceInRutter {
|
|
1655
|
+
type: "rutter";
|
|
1656
|
+
config: RutterConfig;
|
|
1657
|
+
}
|
|
1658
|
+
interface IngestSourceInSafebase {
|
|
1659
|
+
type: "safebase";
|
|
1660
|
+
config: SvixConfig;
|
|
1661
|
+
}
|
|
1662
|
+
interface IngestSourceInSardine {
|
|
1663
|
+
type: "sardine";
|
|
1664
|
+
config: SvixConfig;
|
|
1665
|
+
}
|
|
1666
|
+
interface IngestSourceInSegment {
|
|
1667
|
+
type: "segment";
|
|
1668
|
+
config: SegmentConfig;
|
|
1669
|
+
}
|
|
1670
|
+
interface IngestSourceInShopify {
|
|
1671
|
+
type: "shopify";
|
|
1672
|
+
config: ShopifyConfig;
|
|
1673
|
+
}
|
|
1674
|
+
interface IngestSourceInSlack {
|
|
1675
|
+
type: "slack";
|
|
1676
|
+
config: SlackConfig;
|
|
1677
|
+
}
|
|
1678
|
+
interface IngestSourceInStripe {
|
|
1679
|
+
type: "stripe";
|
|
1680
|
+
config: StripeConfig;
|
|
1681
|
+
}
|
|
1682
|
+
interface IngestSourceInStych {
|
|
1683
|
+
type: "stych";
|
|
1684
|
+
config: SvixConfig;
|
|
1685
|
+
}
|
|
1686
|
+
interface IngestSourceInSvix {
|
|
1687
|
+
type: "svix";
|
|
1688
|
+
config: SvixConfig;
|
|
1689
|
+
}
|
|
1690
|
+
interface IngestSourceInZoom {
|
|
1691
|
+
type: "zoom";
|
|
1692
|
+
config: ZoomConfig;
|
|
1693
|
+
}
|
|
1694
|
+
interface IngestSourceInTailscale {
|
|
1695
|
+
type: "tailscale";
|
|
1696
|
+
config: TailscaleConfig;
|
|
1697
|
+
}
|
|
1698
|
+
interface IngestSourceInTelnyx {
|
|
1699
|
+
type: "telnyx";
|
|
1700
|
+
config: TelnyxConfig;
|
|
1701
|
+
}
|
|
1702
|
+
interface IngestSourceInVapi {
|
|
1703
|
+
type: "vapi";
|
|
1704
|
+
config: VapiConfig;
|
|
1705
|
+
}
|
|
1706
|
+
interface IngestSourceInOpenAi {
|
|
1707
|
+
type: "open-ai";
|
|
1708
|
+
config: SvixConfig;
|
|
1709
|
+
}
|
|
1710
|
+
interface IngestSourceInRender {
|
|
1711
|
+
type: "render";
|
|
1712
|
+
config: SvixConfig;
|
|
1713
|
+
}
|
|
1714
|
+
interface IngestSourceInVeriff {
|
|
1715
|
+
type: "veriff";
|
|
1716
|
+
config: VeriffConfig;
|
|
1717
|
+
}
|
|
1718
|
+
interface IngestSourceInAirwallex {
|
|
1719
|
+
type: "airwallex";
|
|
1720
|
+
config: AirwallexConfig;
|
|
1721
|
+
}
|
|
1722
|
+
interface IngestSourceInVgs {
|
|
1723
|
+
type: "vgs";
|
|
1724
|
+
config: VgsConfig;
|
|
1725
|
+
}
|
|
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);
|
|
1727
|
+
//#endregion
|
|
1728
|
+
//#region src/models/adobeSignConfigOut.d.ts
|
|
1729
|
+
interface AdobeSignConfigOut {}
|
|
1730
|
+
//#endregion
|
|
1731
|
+
//#region src/models/airwallexConfigOut.d.ts
|
|
1732
|
+
interface AirwallexConfigOut {}
|
|
1733
|
+
//#endregion
|
|
1734
|
+
//#region src/models/checkbookConfigOut.d.ts
|
|
1735
|
+
interface CheckbookConfigOut {}
|
|
1736
|
+
//#endregion
|
|
1737
|
+
//#region src/models/docusignConfigOut.d.ts
|
|
1738
|
+
interface DocusignConfigOut {}
|
|
1739
|
+
//#endregion
|
|
1740
|
+
//#region src/models/easypostConfigOut.d.ts
|
|
1741
|
+
interface EasypostConfigOut {}
|
|
1742
|
+
//#endregion
|
|
1743
|
+
//#region src/models/githubConfigOut.d.ts
|
|
1744
|
+
interface GithubConfigOut {}
|
|
1745
|
+
//#endregion
|
|
1746
|
+
//#region src/models/hubspotConfigOut.d.ts
|
|
1747
|
+
interface HubspotConfigOut {}
|
|
1748
|
+
//#endregion
|
|
1749
|
+
//#region src/models/metaConfigOut.d.ts
|
|
1750
|
+
interface MetaConfigOut {}
|
|
1751
|
+
//#endregion
|
|
1752
|
+
//#region src/models/nangoConfigOut.d.ts
|
|
1753
|
+
interface NangoConfigOut {}
|
|
1754
|
+
//#endregion
|
|
1755
|
+
//#region src/models/openClawConfigOut.d.ts
|
|
1756
|
+
interface OpenClawConfigOut {}
|
|
1757
|
+
//#endregion
|
|
1758
|
+
//#region src/models/orumIoConfigOut.d.ts
|
|
1759
|
+
interface OrumIoConfigOut {
|
|
1760
|
+
publicKey: string;
|
|
1761
|
+
}
|
|
1762
|
+
//#endregion
|
|
1763
|
+
//#region src/models/pandaDocConfigOut.d.ts
|
|
1764
|
+
interface PandaDocConfigOut {}
|
|
1765
|
+
//#endregion
|
|
1766
|
+
//#region src/models/portIoConfigOut.d.ts
|
|
1767
|
+
interface PortIoConfigOut {}
|
|
1768
|
+
//#endregion
|
|
1769
|
+
//#region src/models/rutterConfigOut.d.ts
|
|
1770
|
+
interface RutterConfigOut {}
|
|
1771
|
+
//#endregion
|
|
1772
|
+
//#region src/models/segmentConfigOut.d.ts
|
|
1773
|
+
interface SegmentConfigOut {}
|
|
1774
|
+
//#endregion
|
|
1775
|
+
//#region src/models/shopifyConfigOut.d.ts
|
|
1776
|
+
interface ShopifyConfigOut {}
|
|
1777
|
+
//#endregion
|
|
1778
|
+
//#region src/models/slackConfigOut.d.ts
|
|
1779
|
+
interface SlackConfigOut {}
|
|
1780
|
+
//#endregion
|
|
1781
|
+
//#region src/models/stripeConfigOut.d.ts
|
|
1782
|
+
interface StripeConfigOut {}
|
|
1783
|
+
//#endregion
|
|
1784
|
+
//#region src/models/svixConfigOut.d.ts
|
|
1785
|
+
interface SvixConfigOut {}
|
|
1786
|
+
//#endregion
|
|
1787
|
+
//#region src/models/tailscaleConfigOut.d.ts
|
|
1788
|
+
interface TailscaleConfigOut {}
|
|
1789
|
+
//#endregion
|
|
1790
|
+
//#region src/models/telnyxConfigOut.d.ts
|
|
1791
|
+
interface TelnyxConfigOut {
|
|
1792
|
+
publicKey: string;
|
|
1793
|
+
}
|
|
1794
|
+
//#endregion
|
|
1795
|
+
//#region src/models/vapiConfigOut.d.ts
|
|
1796
|
+
interface VapiConfigOut {}
|
|
1797
|
+
//#endregion
|
|
1798
|
+
//#region src/models/veriffConfigOut.d.ts
|
|
1799
|
+
interface VeriffConfigOut {}
|
|
1800
|
+
//#endregion
|
|
1801
|
+
//#region src/models/vgsConfigOut.d.ts
|
|
1802
|
+
interface VgsConfigOut {}
|
|
1803
|
+
//#endregion
|
|
1804
|
+
//#region src/models/zoomConfigOut.d.ts
|
|
1805
|
+
interface ZoomConfigOut {}
|
|
1806
|
+
//#endregion
|
|
1807
|
+
//#region src/models/ingestSourceOut.d.ts
|
|
1808
|
+
interface _IngestSourceOutFields {
|
|
1809
|
+
/** The Source's ID. */
|
|
1810
|
+
id: string;
|
|
1811
|
+
/** The Source's UID. */
|
|
1812
|
+
uid?: string | null;
|
|
1813
|
+
name: string;
|
|
1814
|
+
ingestUrl?: string | null;
|
|
1815
|
+
createdAt: Date;
|
|
1816
|
+
updatedAt: Date;
|
|
1817
|
+
metadata: {
|
|
1818
|
+
[key: string]: string;
|
|
1819
|
+
};
|
|
1820
|
+
}
|
|
1821
|
+
interface IngestSourceOutGenericWebhookConfig {}
|
|
1822
|
+
interface IngestSourceOutGenericWebhook {
|
|
1823
|
+
type: "generic-webhook";
|
|
1824
|
+
config?: IngestSourceOutGenericWebhookConfig;
|
|
1825
|
+
}
|
|
1826
|
+
interface IngestSourceOutCron {
|
|
1827
|
+
type: "cron";
|
|
1828
|
+
config: CronConfig;
|
|
1829
|
+
}
|
|
1830
|
+
interface IngestSourceOutAdobeSign {
|
|
1831
|
+
type: "adobe-sign";
|
|
1832
|
+
config: AdobeSignConfigOut;
|
|
1833
|
+
}
|
|
1834
|
+
interface IngestSourceOutBeehiiv {
|
|
1835
|
+
type: "beehiiv";
|
|
1836
|
+
config: SvixConfigOut;
|
|
1837
|
+
}
|
|
1838
|
+
interface IngestSourceOutBrex {
|
|
1839
|
+
type: "brex";
|
|
1840
|
+
config: SvixConfigOut;
|
|
1841
|
+
}
|
|
1842
|
+
interface IngestSourceOutCheckbook {
|
|
1843
|
+
type: "checkbook";
|
|
1844
|
+
config: CheckbookConfigOut;
|
|
1845
|
+
}
|
|
1846
|
+
interface IngestSourceOutClerk {
|
|
1847
|
+
type: "clerk";
|
|
1848
|
+
config: SvixConfigOut;
|
|
1849
|
+
}
|
|
1850
|
+
interface IngestSourceOutDocusign {
|
|
1851
|
+
type: "docusign";
|
|
1852
|
+
config: DocusignConfigOut;
|
|
1853
|
+
}
|
|
1854
|
+
interface IngestSourceOutEasypost {
|
|
1855
|
+
type: "easypost";
|
|
1856
|
+
config: EasypostConfigOut;
|
|
1857
|
+
}
|
|
1858
|
+
interface IngestSourceOutGithub {
|
|
1859
|
+
type: "github";
|
|
1860
|
+
config: GithubConfigOut;
|
|
1861
|
+
}
|
|
1862
|
+
interface IngestSourceOutGuesty {
|
|
1863
|
+
type: "guesty";
|
|
1864
|
+
config: SvixConfigOut;
|
|
1865
|
+
}
|
|
1866
|
+
interface IngestSourceOutHubspot {
|
|
1867
|
+
type: "hubspot";
|
|
1868
|
+
config: HubspotConfigOut;
|
|
1869
|
+
}
|
|
1870
|
+
interface IngestSourceOutIncidentIo {
|
|
1871
|
+
type: "incident-io";
|
|
1872
|
+
config: SvixConfigOut;
|
|
1873
|
+
}
|
|
1874
|
+
interface IngestSourceOutLithic {
|
|
1875
|
+
type: "lithic";
|
|
1876
|
+
config: SvixConfigOut;
|
|
1877
|
+
}
|
|
1878
|
+
interface IngestSourceOutMeta {
|
|
1879
|
+
type: "meta";
|
|
1880
|
+
config: MetaConfigOut;
|
|
1881
|
+
}
|
|
1882
|
+
interface IngestSourceOutNango {
|
|
1883
|
+
type: "nango";
|
|
1884
|
+
config: NangoConfigOut;
|
|
1885
|
+
}
|
|
1886
|
+
interface IngestSourceOutNash {
|
|
1887
|
+
type: "nash";
|
|
1888
|
+
config: SvixConfigOut;
|
|
1889
|
+
}
|
|
1890
|
+
interface IngestSourceOutOpenclaw {
|
|
1891
|
+
type: "openclaw";
|
|
1892
|
+
config: OpenClawConfigOut;
|
|
1893
|
+
}
|
|
1894
|
+
interface IngestSourceOutOrumIo {
|
|
1895
|
+
type: "orum-io";
|
|
1896
|
+
config: OrumIoConfigOut;
|
|
1897
|
+
}
|
|
1898
|
+
interface IngestSourceOutPandaDoc {
|
|
1899
|
+
type: "panda-doc";
|
|
1900
|
+
config: PandaDocConfigOut;
|
|
1901
|
+
}
|
|
1902
|
+
interface IngestSourceOutPortIo {
|
|
1903
|
+
type: "port-io";
|
|
1904
|
+
config: PortIoConfigOut;
|
|
1905
|
+
}
|
|
1906
|
+
interface IngestSourceOutPsiFi {
|
|
1907
|
+
type: "psi-fi";
|
|
1908
|
+
config: SvixConfigOut;
|
|
1909
|
+
}
|
|
1910
|
+
interface IngestSourceOutPleo {
|
|
1911
|
+
type: "pleo";
|
|
1912
|
+
config: SvixConfigOut;
|
|
1913
|
+
}
|
|
1914
|
+
interface IngestSourceOutReplicate {
|
|
1915
|
+
type: "replicate";
|
|
1916
|
+
config: SvixConfigOut;
|
|
1917
|
+
}
|
|
1918
|
+
interface IngestSourceOutResend {
|
|
1919
|
+
type: "resend";
|
|
1920
|
+
config: SvixConfigOut;
|
|
1921
|
+
}
|
|
1922
|
+
interface IngestSourceOutRutter {
|
|
1923
|
+
type: "rutter";
|
|
1924
|
+
config: RutterConfigOut;
|
|
1925
|
+
}
|
|
1926
|
+
interface IngestSourceOutSafebase {
|
|
1927
|
+
type: "safebase";
|
|
1928
|
+
config: SvixConfigOut;
|
|
1929
|
+
}
|
|
1930
|
+
interface IngestSourceOutSardine {
|
|
1931
|
+
type: "sardine";
|
|
1932
|
+
config: SvixConfigOut;
|
|
1933
|
+
}
|
|
1934
|
+
interface IngestSourceOutSegment {
|
|
1935
|
+
type: "segment";
|
|
1936
|
+
config: SegmentConfigOut;
|
|
1937
|
+
}
|
|
1938
|
+
interface IngestSourceOutShopify {
|
|
1939
|
+
type: "shopify";
|
|
1940
|
+
config: ShopifyConfigOut;
|
|
1941
|
+
}
|
|
1942
|
+
interface IngestSourceOutSlack {
|
|
1943
|
+
type: "slack";
|
|
1944
|
+
config: SlackConfigOut;
|
|
1945
|
+
}
|
|
1946
|
+
interface IngestSourceOutStripe {
|
|
1947
|
+
type: "stripe";
|
|
1948
|
+
config: StripeConfigOut;
|
|
1949
|
+
}
|
|
1950
|
+
interface IngestSourceOutStych {
|
|
1951
|
+
type: "stych";
|
|
1952
|
+
config: SvixConfigOut;
|
|
1953
|
+
}
|
|
1954
|
+
interface IngestSourceOutSvix {
|
|
1955
|
+
type: "svix";
|
|
1956
|
+
config: SvixConfigOut;
|
|
1957
|
+
}
|
|
1958
|
+
interface IngestSourceOutZoom {
|
|
1959
|
+
type: "zoom";
|
|
1960
|
+
config: ZoomConfigOut;
|
|
1961
|
+
}
|
|
1962
|
+
interface IngestSourceOutTailscale {
|
|
1963
|
+
type: "tailscale";
|
|
1964
|
+
config: TailscaleConfigOut;
|
|
1965
|
+
}
|
|
1966
|
+
interface IngestSourceOutTelnyx {
|
|
1967
|
+
type: "telnyx";
|
|
1968
|
+
config: TelnyxConfigOut;
|
|
1969
|
+
}
|
|
1970
|
+
interface IngestSourceOutVapi {
|
|
1971
|
+
type: "vapi";
|
|
1972
|
+
config: VapiConfigOut;
|
|
1973
|
+
}
|
|
1974
|
+
interface IngestSourceOutOpenAi {
|
|
1975
|
+
type: "open-ai";
|
|
1976
|
+
config: SvixConfigOut;
|
|
1977
|
+
}
|
|
1978
|
+
interface IngestSourceOutRender {
|
|
1979
|
+
type: "render";
|
|
1980
|
+
config: SvixConfigOut;
|
|
1981
|
+
}
|
|
1982
|
+
interface IngestSourceOutVeriff {
|
|
1983
|
+
type: "veriff";
|
|
1984
|
+
config: VeriffConfigOut;
|
|
1985
|
+
}
|
|
1986
|
+
interface IngestSourceOutAirwallex {
|
|
1987
|
+
type: "airwallex";
|
|
1988
|
+
config: AirwallexConfigOut;
|
|
1989
|
+
}
|
|
1990
|
+
interface IngestSourceOutVgs {
|
|
1991
|
+
type: "vgs";
|
|
1992
|
+
config: VgsConfigOut;
|
|
1993
|
+
}
|
|
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);
|
|
1995
|
+
//#endregion
|
|
1996
|
+
//#region src/models/listResponseIngestSourceOut.d.ts
|
|
1997
|
+
interface ListResponseIngestSourceOut {
|
|
1998
|
+
data: IngestSourceOut[];
|
|
1999
|
+
iterator: string | null;
|
|
2000
|
+
prevIterator?: string | null;
|
|
2001
|
+
done: boolean;
|
|
2002
|
+
}
|
|
2003
|
+
//#endregion
|
|
2004
|
+
//#region src/models/rotateTokenOut.d.ts
|
|
2005
|
+
interface RotateTokenOut {
|
|
2006
|
+
ingestUrl: string;
|
|
2007
|
+
}
|
|
2008
|
+
//#endregion
|
|
2009
|
+
//#region src/api/ingestSource.d.ts
|
|
2010
|
+
interface IngestSourceListOptions {
|
|
2011
|
+
/** Limit the number of returned items */
|
|
2012
|
+
limit?: number;
|
|
2013
|
+
/** The iterator returned from a prior invocation */
|
|
2014
|
+
iterator?: string | null;
|
|
2015
|
+
/** The sorting order of the returned items */
|
|
2016
|
+
order?: Ordering;
|
|
2017
|
+
}
|
|
2018
|
+
interface IngestSourceCreateOptions {
|
|
2019
|
+
idempotencyKey?: string;
|
|
2020
|
+
}
|
|
2021
|
+
interface IngestSourceRotateTokenOptions {
|
|
2022
|
+
idempotencyKey?: string;
|
|
2023
|
+
}
|
|
2024
|
+
declare class IngestSource {
|
|
2025
|
+
private readonly requestCtx;
|
|
2026
|
+
constructor(requestCtx: SvixRequestContext);
|
|
2027
|
+
/** List of all the organization's Ingest Sources. */
|
|
2028
|
+
list(options?: IngestSourceListOptions): Promise<ListResponseIngestSourceOut>;
|
|
2029
|
+
/** Create Ingest Source. */
|
|
2030
|
+
create(ingestSourceIn: IngestSourceIn, options?: IngestSourceCreateOptions): Promise<IngestSourceOut>;
|
|
2031
|
+
/** Get an Ingest Source by id or uid. */
|
|
2032
|
+
get(sourceId: string): Promise<IngestSourceOut>;
|
|
2033
|
+
/** Create or update an Ingest Source. */
|
|
2034
|
+
upsert(sourceId: string, ingestSourceIn: IngestSourceIn): Promise<IngestSourceOut>;
|
|
2035
|
+
/** Delete an Ingest Source. */
|
|
2036
|
+
delete(sourceId: string): Promise<void>;
|
|
2037
|
+
/**
|
|
2038
|
+
* Rotate the Ingest Source's Url Token.
|
|
2039
|
+
*
|
|
2040
|
+
* This will rotate the ingest source's token, which is used to
|
|
2041
|
+
* construct the unique `ingestUrl` for the source. Previous tokens
|
|
2042
|
+
* will remain valid for 48 hours after rotation. The token can be
|
|
2043
|
+
* rotated a maximum of three times within the 48-hour period.
|
|
2044
|
+
*/
|
|
2045
|
+
rotateToken(sourceId: string, options?: IngestSourceRotateTokenOptions): Promise<RotateTokenOut>;
|
|
2046
|
+
}
|
|
2047
|
+
//#endregion
|
|
2048
|
+
//#region src/api/ingest.d.ts
|
|
2049
|
+
declare class Ingest {
|
|
2050
|
+
private readonly requestCtx;
|
|
2051
|
+
constructor(requestCtx: SvixRequestContext);
|
|
2052
|
+
get authentication(): IngestAuthentication;
|
|
2053
|
+
get endpoint(): IngestEndpoint;
|
|
2054
|
+
get source(): IngestSource;
|
|
2055
|
+
}
|
|
2056
|
+
//#endregion
|
|
2057
|
+
//#region src/models/integrationIn.d.ts
|
|
2058
|
+
interface IntegrationIn {
|
|
2059
|
+
name: string;
|
|
2060
|
+
/** The set of feature flags the integration will have access to. */
|
|
2061
|
+
featureFlags?: string[];
|
|
2062
|
+
}
|
|
2063
|
+
//#endregion
|
|
2064
|
+
//#region src/models/integrationKeyOut.d.ts
|
|
2065
|
+
interface IntegrationKeyOut {
|
|
2066
|
+
key: string;
|
|
2067
|
+
}
|
|
2068
|
+
//#endregion
|
|
2069
|
+
//#region src/models/integrationOut.d.ts
|
|
2070
|
+
interface IntegrationOut {
|
|
2071
|
+
name: string;
|
|
2072
|
+
/** The Integration's ID. */
|
|
2073
|
+
id: string;
|
|
2074
|
+
createdAt: Date;
|
|
2075
|
+
updatedAt: Date;
|
|
2076
|
+
/** The set of feature flags the integration has access to. */
|
|
2077
|
+
featureFlags?: string[];
|
|
2078
|
+
}
|
|
2079
|
+
//#endregion
|
|
2080
|
+
//#region src/models/integrationUpdate.d.ts
|
|
2081
|
+
interface IntegrationUpdate {
|
|
2082
|
+
name: string;
|
|
2083
|
+
/** The set of feature flags the integration will have access to. */
|
|
2084
|
+
featureFlags?: string[];
|
|
2085
|
+
}
|
|
2086
|
+
//#endregion
|
|
2087
|
+
//#region src/models/listResponseIntegrationOut.d.ts
|
|
2088
|
+
interface ListResponseIntegrationOut {
|
|
2089
|
+
data: IntegrationOut[];
|
|
2090
|
+
iterator: string | null;
|
|
2091
|
+
prevIterator?: string | null;
|
|
2092
|
+
done: boolean;
|
|
2093
|
+
}
|
|
2094
|
+
//#endregion
|
|
2095
|
+
//#region src/api/integration.d.ts
|
|
2096
|
+
interface IntegrationListOptions {
|
|
2097
|
+
/** Limit the number of returned items */
|
|
2098
|
+
limit?: number;
|
|
2099
|
+
/** The iterator returned from a prior invocation */
|
|
2100
|
+
iterator?: string | null;
|
|
2101
|
+
/** The sorting order of the returned items */
|
|
2102
|
+
order?: Ordering;
|
|
2103
|
+
}
|
|
2104
|
+
interface IntegrationCreateOptions {
|
|
2105
|
+
idempotencyKey?: string;
|
|
2106
|
+
}
|
|
2107
|
+
interface IntegrationRotateKeyOptions {
|
|
2108
|
+
idempotencyKey?: string;
|
|
2109
|
+
}
|
|
2110
|
+
declare class Integration {
|
|
2111
|
+
private readonly requestCtx;
|
|
2112
|
+
constructor(requestCtx: SvixRequestContext);
|
|
2113
|
+
/** List the application's integrations. */
|
|
2114
|
+
list(appId: string, options?: IntegrationListOptions): Promise<ListResponseIntegrationOut>;
|
|
2115
|
+
/** Create an integration. */
|
|
2116
|
+
create(appId: string, integrationIn: IntegrationIn, options?: IntegrationCreateOptions): Promise<IntegrationOut>;
|
|
2117
|
+
/** Get an integration. */
|
|
2118
|
+
get(appId: string, integId: string): Promise<IntegrationOut>;
|
|
2119
|
+
/** Update an integration. */
|
|
2120
|
+
update(appId: string, integId: string, integrationUpdate: IntegrationUpdate): Promise<IntegrationOut>;
|
|
2121
|
+
/** Delete an integration. */
|
|
2122
|
+
delete(appId: string, integId: string): Promise<void>;
|
|
2123
|
+
/** Rotate the integration's key. The previous key will be immediately revoked. */
|
|
2124
|
+
rotateKey(appId: string, integId: string, options?: IntegrationRotateKeyOptions): Promise<IntegrationKeyOut>;
|
|
2125
|
+
}
|
|
2126
|
+
//#endregion
|
|
2127
|
+
//#region src/models/expungeAllContentsOut.d.ts
|
|
2128
|
+
interface ExpungeAllContentsOut {
|
|
2129
|
+
/** The QueueBackgroundTask's ID. */
|
|
2130
|
+
id: string;
|
|
2131
|
+
status: BackgroundTaskStatus;
|
|
2132
|
+
task: BackgroundTaskType;
|
|
2133
|
+
updatedAt: Date;
|
|
2134
|
+
}
|
|
2135
|
+
//#endregion
|
|
2136
|
+
//#region src/models/listResponseMessageOut.d.ts
|
|
2137
|
+
interface ListResponseMessageOut {
|
|
2138
|
+
data: MessageOut[];
|
|
2139
|
+
iterator: string | null;
|
|
2140
|
+
prevIterator?: string | null;
|
|
2141
|
+
done: boolean;
|
|
2142
|
+
}
|
|
2143
|
+
//#endregion
|
|
2144
|
+
//#region src/models/messagePrecheckIn.d.ts
|
|
2145
|
+
interface MessagePrecheckIn {
|
|
2146
|
+
/** The event type's name */
|
|
2147
|
+
eventType: string;
|
|
2148
|
+
channels?: string[] | null;
|
|
2149
|
+
}
|
|
2150
|
+
//#endregion
|
|
2151
|
+
//#region src/models/messagePrecheckOut.d.ts
|
|
2152
|
+
interface MessagePrecheckOut {
|
|
2153
|
+
/** Whether there are any active endpoint that would get sent such a message. */
|
|
2154
|
+
active: boolean;
|
|
2155
|
+
}
|
|
2156
|
+
//#endregion
|
|
2157
|
+
//#region src/models/pollingEndpointConsumerSeekIn.d.ts
|
|
2158
|
+
interface PollingEndpointConsumerSeekIn {
|
|
2159
|
+
after: Date;
|
|
2160
|
+
}
|
|
2161
|
+
//#endregion
|
|
2162
|
+
//#region src/models/pollingEndpointConsumerSeekOut.d.ts
|
|
2163
|
+
interface PollingEndpointConsumerSeekOut {
|
|
2164
|
+
iterator: string;
|
|
2165
|
+
}
|
|
2166
|
+
//#endregion
|
|
2167
|
+
//#region src/models/pollingEndpointMessageOut.d.ts
|
|
2168
|
+
/** The MessageOut equivalent of polling endpoint */
|
|
2169
|
+
interface PollingEndpointMessageOut {
|
|
2170
|
+
headers?: {
|
|
2171
|
+
[key: string]: string;
|
|
2172
|
+
} | null;
|
|
2173
|
+
/** Optional unique identifier for the message */
|
|
2174
|
+
eventId?: string | null;
|
|
2175
|
+
/** The event type's name */
|
|
2176
|
+
eventType: string;
|
|
2177
|
+
payload: any;
|
|
2178
|
+
/** List of free-form identifiers that endpoints can filter by */
|
|
2179
|
+
channels?: string[] | null;
|
|
2180
|
+
/** The Message's ID. */
|
|
2181
|
+
id: string;
|
|
2182
|
+
timestamp: Date;
|
|
2183
|
+
tags?: string[] | null;
|
|
2184
|
+
deliverAt?: Date | null;
|
|
2185
|
+
}
|
|
2186
|
+
//#endregion
|
|
2187
|
+
//#region src/models/pollingEndpointOut.d.ts
|
|
2188
|
+
interface PollingEndpointOut {
|
|
2189
|
+
data: PollingEndpointMessageOut[];
|
|
2190
|
+
iterator: string;
|
|
2191
|
+
done: boolean;
|
|
2192
|
+
}
|
|
2193
|
+
//#endregion
|
|
2194
|
+
//#region src/api/messagePoller.d.ts
|
|
2195
|
+
interface MessagePollerPollOptions {
|
|
2196
|
+
/** Limit the number of returned items */
|
|
2197
|
+
limit?: number;
|
|
2198
|
+
/** The iterator returned from a prior invocation */
|
|
2199
|
+
iterator?: string | null;
|
|
2200
|
+
/** Filters messages sent with this event type (optional). */
|
|
2201
|
+
eventType?: string;
|
|
2202
|
+
/** Filters messages sent with this channel (optional). */
|
|
2203
|
+
channel?: string;
|
|
2204
|
+
after?: Date | null;
|
|
2205
|
+
}
|
|
2206
|
+
interface MessagePollerConsumerSeekOptions {
|
|
2207
|
+
idempotencyKey?: string;
|
|
2208
|
+
}
|
|
2209
|
+
interface MessagePollerConsumerPollOptions {
|
|
2210
|
+
/** Limit the number of returned items */
|
|
2211
|
+
limit?: number;
|
|
2212
|
+
/** The iterator returned from a prior invocation */
|
|
2213
|
+
iterator?: string | null;
|
|
2214
|
+
}
|
|
2215
|
+
declare class MessagePoller {
|
|
2216
|
+
private readonly requestCtx;
|
|
2217
|
+
constructor(requestCtx: SvixRequestContext);
|
|
2218
|
+
/** Reads the stream of created messages for an application, filtered on the Sink's event types and Channels. */
|
|
2219
|
+
poll(appId: string, sinkId: string, options?: MessagePollerPollOptions): Promise<PollingEndpointOut>;
|
|
2220
|
+
/** Sets the starting offset for the consumer of a polling endpoint. */
|
|
2221
|
+
consumerSeek(appId: string, sinkId: string, consumerId: string, pollingEndpointConsumerSeekIn: PollingEndpointConsumerSeekIn, options?: MessagePollerConsumerSeekOptions): Promise<PollingEndpointConsumerSeekOut>;
|
|
2222
|
+
/**
|
|
2223
|
+
* Reads the stream of created messages for an application, filtered on the Sink's event types and
|
|
2224
|
+
* Channels, using server-managed iterator tracking.
|
|
2225
|
+
*/
|
|
2226
|
+
consumerPoll(appId: string, sinkId: string, consumerId: string, options?: MessagePollerConsumerPollOptions): Promise<PollingEndpointOut>;
|
|
2227
|
+
}
|
|
2228
|
+
//#endregion
|
|
2229
|
+
//#region src/models/messageIn.d.ts
|
|
2230
|
+
interface MessageIn {
|
|
2231
|
+
/** Optional unique identifier for the message */
|
|
2232
|
+
eventId?: string | null;
|
|
2233
|
+
/** The event type's name */
|
|
2234
|
+
eventType: string;
|
|
2235
|
+
/**
|
|
2236
|
+
* JSON payload to send as the request body of the webhook.
|
|
2237
|
+
*
|
|
2238
|
+
* We also support sending non-JSON payloads. Please contact us for more information.
|
|
2239
|
+
*/
|
|
2240
|
+
payload: any;
|
|
2241
|
+
/** List of free-form identifiers that endpoints can filter by */
|
|
2242
|
+
channels?: string[] | null;
|
|
2243
|
+
/**
|
|
2244
|
+
* Optionally creates a new application alongside the message.
|
|
2245
|
+
*
|
|
2246
|
+
* If the application id or uid that is used in the path already exists, this argument is ignored.
|
|
2247
|
+
*/
|
|
2248
|
+
application?: ApplicationIn | null;
|
|
2249
|
+
/** List of free-form tags that can be filtered by when listing messages */
|
|
2250
|
+
tags?: string[] | null;
|
|
2251
|
+
/** Extra parameters to pass to Transformations (for future use) */
|
|
2252
|
+
transformationsParams?: any | null;
|
|
2253
|
+
/**
|
|
2254
|
+
* The date and time at which the message will be delivered.
|
|
2255
|
+
*
|
|
2256
|
+
* Note that this time is best-effort-only. Must be at least one minute and no more than 24 hours in the future.
|
|
2257
|
+
*/
|
|
2258
|
+
deliverAt?: Date | null;
|
|
2259
|
+
/** Optional number of days to retain the message payload. Defaults to 90. Note that this is mutually exclusive with `payloadRetentionHours`. */
|
|
2260
|
+
payloadRetentionPeriod?: number | null;
|
|
2261
|
+
/** Optional number of hours to retain the message payload. Note that this is mutually exclusive with `payloadRetentionPeriod`. */
|
|
2262
|
+
payloadRetentionHours?: number | null;
|
|
2263
|
+
}
|
|
2264
|
+
//#endregion
|
|
2265
|
+
//#region src/api/message.d.ts
|
|
2266
|
+
interface MessageListOptions {
|
|
2267
|
+
/** Limit the number of returned items */
|
|
2268
|
+
limit?: number;
|
|
2269
|
+
/** The iterator returned from a prior invocation */
|
|
2270
|
+
iterator?: string | null;
|
|
2271
|
+
/** Filter response based on the channel. */
|
|
2272
|
+
channel?: string;
|
|
2273
|
+
/** Only include items created before a certain date. */
|
|
2274
|
+
before?: Date | null;
|
|
2275
|
+
/** Only include items created after a certain date. */
|
|
2276
|
+
after?: Date | null;
|
|
2277
|
+
/**
|
|
2278
|
+
* When `true` message payloads are included in the response.
|
|
2279
|
+
*
|
|
2280
|
+
* Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request without specifying this parameter.
|
|
2281
|
+
*/
|
|
2282
|
+
withContent?: boolean;
|
|
2283
|
+
/** Filter messages matching the provided tag. */
|
|
2284
|
+
tag?: string;
|
|
2285
|
+
/** Filter response based on the event type */
|
|
2286
|
+
eventTypes?: string[];
|
|
2287
|
+
}
|
|
2288
|
+
interface MessageCreateOptions {
|
|
2289
|
+
/**
|
|
2290
|
+
* When `true`, message payloads are included in the response.
|
|
2291
|
+
*
|
|
2292
|
+
* Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request without specifying this parameter.
|
|
2293
|
+
*/
|
|
2294
|
+
withContent?: boolean;
|
|
2295
|
+
idempotencyKey?: string;
|
|
2296
|
+
}
|
|
2297
|
+
interface MessagePrecheckOptions {
|
|
2298
|
+
idempotencyKey?: string;
|
|
2299
|
+
}
|
|
2300
|
+
interface MessageGetOptions {
|
|
2301
|
+
/**
|
|
2302
|
+
* When `true` message payloads are included in the response.
|
|
2303
|
+
*
|
|
2304
|
+
* Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request without specifying this parameter.
|
|
2305
|
+
*/
|
|
2306
|
+
withContent?: boolean;
|
|
2307
|
+
}
|
|
2308
|
+
interface MessageExpungeAllContentsOptions {
|
|
2309
|
+
idempotencyKey?: string;
|
|
2310
|
+
}
|
|
2311
|
+
declare class Message {
|
|
2312
|
+
private readonly requestCtx;
|
|
2313
|
+
constructor(requestCtx: SvixRequestContext);
|
|
2314
|
+
get poller(): MessagePoller;
|
|
2315
|
+
/**
|
|
2316
|
+
* List all of the application's messages.
|
|
2317
|
+
*
|
|
2318
|
+
* The `before` and `after` parameters let you filter all items created before or after a certain date. These can be
|
|
2319
|
+
* used alongside an iterator to paginate over results within a certain window.
|
|
2320
|
+
*
|
|
2321
|
+
* Note that by default this endpoint is limited to retrieving 90 days' worth of data
|
|
2322
|
+
* relative to now or, if an iterator is provided, 90 days before/after the time indicated
|
|
2323
|
+
* by the iterator ID. If you require data beyond those time ranges, you will need to explicitly
|
|
2324
|
+
* set the `before` or `after` parameter as appropriate.
|
|
2325
|
+
*/
|
|
2326
|
+
list(appId: string, options?: MessageListOptions): Promise<ListResponseMessageOut>;
|
|
2327
|
+
/**
|
|
2328
|
+
* Creates a new message and dispatches it to all of the application's endpoints.
|
|
2329
|
+
*
|
|
2330
|
+
* The `eventId` is an optional custom unique ID. It's verified to be unique only up to a day, after that no verification will be made.
|
|
2331
|
+
* If a message with the same `eventId` already exists for the application, a 409 conflict error will be returned.
|
|
2332
|
+
*
|
|
2333
|
+
* The `eventType` indicates the type and schema of the event. All messages of a certain `eventType` are expected to have the same schema. Endpoints can choose to only listen to specific event types.
|
|
2334
|
+
* Messages can also have `channels`, which similar to event types let endpoints filter by them. Unlike event types, messages can have multiple channels, and channels don't imply a specific message content or schema.
|
|
2335
|
+
*
|
|
2336
|
+
* The `payload` property is the webhook's body (the actual webhook message). Svix supports payload sizes of up to 1MiB, though it's generally a good idea to keep webhook payloads small, probably no larger than 40kb.
|
|
2337
|
+
*/
|
|
2338
|
+
create(appId: string, messageIn: MessageIn, options?: MessageCreateOptions): Promise<MessageOut>;
|
|
2339
|
+
/**
|
|
2340
|
+
* A pre-check call for `message.create` that checks whether any active endpoints are
|
|
2341
|
+
* listening to this message.
|
|
2342
|
+
*
|
|
2343
|
+
* Note: most people shouldn't be using this API. Svix doesn't bill you for
|
|
2344
|
+
* messages not actually sent, so using this API doesn't save money.
|
|
2345
|
+
* If unsure, please ask Svix support before using this API.
|
|
2346
|
+
*/
|
|
2347
|
+
precheck(appId: string, messagePrecheckIn: MessagePrecheckIn, options?: MessagePrecheckOptions): Promise<MessagePrecheckOut>;
|
|
2348
|
+
/** Get a message by its ID or eventID. */
|
|
2349
|
+
get(appId: string, msgId: string, options?: MessageGetOptions): Promise<MessageOut>;
|
|
2350
|
+
/**
|
|
2351
|
+
* Delete the given message's payload.
|
|
2352
|
+
*
|
|
2353
|
+
* Useful in cases when a message was accidentally sent with sensitive content.
|
|
2354
|
+
* The message can't be replayed or resent once its payload has been deleted or expired.
|
|
2355
|
+
*/
|
|
2356
|
+
expungeContent(appId: string, msgId: string): Promise<void>;
|
|
2357
|
+
/**
|
|
2358
|
+
* Delete all message payloads for the application.
|
|
2359
|
+
*
|
|
2360
|
+
* This operation is only available in the <a href="https://svix.com/pricing" target="_blank">Enterprise</a> plan.
|
|
2361
|
+
*
|
|
2362
|
+
* A completed task will return a payload like the following:
|
|
2363
|
+
* ```json
|
|
2364
|
+
* {
|
|
2365
|
+
* "id": "qtask_33qen93MNuelBAq1T9G7eHLJRsF",
|
|
2366
|
+
* "status": "finished",
|
|
2367
|
+
* "task": "application.purge_content",
|
|
2368
|
+
* "data": {
|
|
2369
|
+
* "messagesPurged": 150
|
|
2370
|
+
* }
|
|
2371
|
+
* }
|
|
2372
|
+
* ```
|
|
2373
|
+
*/
|
|
2374
|
+
expungeAllContents(appId: string, options?: MessageExpungeAllContentsOptions): Promise<ExpungeAllContentsOut>;
|
|
2375
|
+
}
|
|
2376
|
+
/**
|
|
2377
|
+
* Creates a `MessageIn` with a raw string payload.
|
|
2378
|
+
*
|
|
2379
|
+
* The payload is not normalized on the server. Normally, payloads are
|
|
2380
|
+
* required to be JSON, and Svix will minify the payload before sending the
|
|
2381
|
+
* webhooks (for example, by removing extraneous whitespace or unnecessarily
|
|
2382
|
+
* escaped characters in strings). With this function, the payload will be
|
|
2383
|
+
* sent "as is", without any minification or other processing.
|
|
2384
|
+
*
|
|
2385
|
+
* @param payload Serialized message payload
|
|
2386
|
+
* @param contentType The value to use for the Content-Type header of the webhook sent by Svix, overwriting the default of `application/json` if specified
|
|
2387
|
+
*
|
|
2388
|
+
* See the class documentation for details about the other parameters.
|
|
2389
|
+
*/
|
|
2390
|
+
declare function messageInRaw(eventType: string, payload: string, contentType?: string): MessageIn;
|
|
2391
|
+
//#endregion
|
|
2392
|
+
//#region src/models/emptyResponse.d.ts
|
|
2393
|
+
interface EmptyResponse {}
|
|
2394
|
+
//#endregion
|
|
2395
|
+
//#region src/models/messageStatusText.d.ts
|
|
2396
|
+
declare enum MessageStatusText {
|
|
2397
|
+
Success = "success",
|
|
2398
|
+
Pending = "pending",
|
|
2399
|
+
Fail = "fail",
|
|
2400
|
+
Sending = "sending",
|
|
2401
|
+
Canceled = "canceled"
|
|
2402
|
+
}
|
|
2403
|
+
//#endregion
|
|
2404
|
+
//#region src/models/endpointMessageOut.d.ts
|
|
2405
|
+
/** A model containing information on a given message plus additional fields on the last attempt for that message. */
|
|
2406
|
+
interface EndpointMessageOut {
|
|
2407
|
+
status: MessageStatus;
|
|
2408
|
+
statusText: MessageStatusText;
|
|
2409
|
+
nextAttempt?: Date | null;
|
|
2410
|
+
/** Optional unique identifier for the message */
|
|
2411
|
+
eventId?: string | null;
|
|
2412
|
+
/** The event type's name */
|
|
2413
|
+
eventType: string;
|
|
2414
|
+
payload: any;
|
|
2415
|
+
/** List of free-form identifiers that endpoints can filter by */
|
|
2416
|
+
channels?: string[] | null;
|
|
2417
|
+
/** The Message's ID. */
|
|
2418
|
+
id: string;
|
|
2419
|
+
timestamp: Date;
|
|
2420
|
+
tags?: string[] | null;
|
|
2421
|
+
deliverAt?: Date | null;
|
|
2422
|
+
}
|
|
2423
|
+
//#endregion
|
|
2424
|
+
//#region src/models/listResponseEndpointMessageOut.d.ts
|
|
2425
|
+
interface ListResponseEndpointMessageOut {
|
|
2426
|
+
data: EndpointMessageOut[];
|
|
2427
|
+
iterator: string | null;
|
|
2428
|
+
prevIterator?: string | null;
|
|
2429
|
+
done: boolean;
|
|
2430
|
+
}
|
|
2431
|
+
//#endregion
|
|
2432
|
+
//#region src/models/messageAttemptTriggerType.d.ts
|
|
2433
|
+
/**
|
|
2434
|
+
* The reason an attempt was made:
|
|
2435
|
+
*
|
|
2436
|
+
* - Scheduled = 0
|
|
2437
|
+
* - Manual = 1
|
|
2438
|
+
*/
|
|
2439
|
+
declare enum MessageAttemptTriggerType {
|
|
2440
|
+
Scheduled = 0,
|
|
2441
|
+
Manual = 1
|
|
2442
|
+
}
|
|
2443
|
+
//#endregion
|
|
2444
|
+
//#region src/models/messageAttemptOut.d.ts
|
|
2445
|
+
interface MessageAttemptOut {
|
|
2446
|
+
url: string;
|
|
2447
|
+
response: string;
|
|
2448
|
+
responseStatusCode: number;
|
|
2449
|
+
/** Response duration in milliseconds. */
|
|
2450
|
+
responseDurationMs: number;
|
|
2451
|
+
status: MessageStatus;
|
|
2452
|
+
statusText: MessageStatusText;
|
|
2453
|
+
triggerType: MessageAttemptTriggerType;
|
|
2454
|
+
/** The Message's ID. */
|
|
2455
|
+
msgId: string;
|
|
2456
|
+
/** The Endpoint's ID. */
|
|
2457
|
+
endpointId: string;
|
|
2458
|
+
/** The MessageAttempt's ID. */
|
|
2459
|
+
id: string;
|
|
2460
|
+
timestamp: Date;
|
|
2461
|
+
msg?: MessageOut | null;
|
|
2462
|
+
}
|
|
2463
|
+
//#endregion
|
|
2464
|
+
//#region src/models/listResponseMessageAttemptOut.d.ts
|
|
2465
|
+
interface ListResponseMessageAttemptOut {
|
|
2466
|
+
data: MessageAttemptOut[];
|
|
2467
|
+
iterator: string | null;
|
|
2468
|
+
prevIterator?: string | null;
|
|
2469
|
+
done: boolean;
|
|
2470
|
+
}
|
|
2471
|
+
//#endregion
|
|
2472
|
+
//#region src/models/messageEndpointOut.d.ts
|
|
2473
|
+
interface MessageEndpointOut {
|
|
2474
|
+
/** The Endpoint's ID. */
|
|
2475
|
+
id: string;
|
|
2476
|
+
status: MessageStatus;
|
|
2477
|
+
statusText: MessageStatusText;
|
|
2478
|
+
nextAttempt?: Date | null;
|
|
2479
|
+
url: string;
|
|
2480
|
+
description: string;
|
|
2481
|
+
/**
|
|
2482
|
+
* Maximum messages per second to send to this endpoint.
|
|
2483
|
+
*
|
|
2484
|
+
* Outgoing messages will be throttled to this rate.
|
|
2485
|
+
*/
|
|
2486
|
+
throttleRate?: number | null;
|
|
2487
|
+
/** Optional unique identifier for the endpoint. */
|
|
2488
|
+
uid?: string | null;
|
|
2489
|
+
disabled?: boolean;
|
|
2490
|
+
eventTypes?: string[] | null;
|
|
2491
|
+
/** List of message channels this endpoint listens to (omit for all). */
|
|
2492
|
+
channels?: string[] | null;
|
|
2493
|
+
createdAt: Date;
|
|
2494
|
+
updatedAt: Date;
|
|
2495
|
+
}
|
|
2496
|
+
//#endregion
|
|
2497
|
+
//#region src/models/listResponseMessageEndpointOut.d.ts
|
|
2498
|
+
interface ListResponseMessageEndpointOut {
|
|
2499
|
+
data: MessageEndpointOut[];
|
|
2500
|
+
iterator: string | null;
|
|
2501
|
+
prevIterator?: string | null;
|
|
2502
|
+
done: boolean;
|
|
2503
|
+
}
|
|
2504
|
+
//#endregion
|
|
2505
|
+
//#region src/api/messageAttempt.d.ts
|
|
2506
|
+
interface MessageAttemptListByEndpointOptions {
|
|
2507
|
+
/** Limit the number of returned items */
|
|
2508
|
+
limit?: number;
|
|
2509
|
+
/** The iterator returned from a prior invocation */
|
|
2510
|
+
iterator?: string | null;
|
|
2511
|
+
/** Filter response based on the status of the attempt: Success (0), Pending (1), Failed (2), Sending (3), or Canceled (4) */
|
|
2512
|
+
status?: MessageStatus;
|
|
2513
|
+
/** Filter response based on the HTTP status code */
|
|
2514
|
+
statusCodeClass?: StatusCodeClass;
|
|
2515
|
+
/** Filter response based on the channel */
|
|
2516
|
+
channel?: string;
|
|
2517
|
+
/** Filter response based on the tag */
|
|
2518
|
+
tag?: string;
|
|
2519
|
+
/** Only include items created before a certain date */
|
|
2520
|
+
before?: Date | null;
|
|
2521
|
+
/** Only include items created after a certain date */
|
|
2522
|
+
after?: Date | null;
|
|
2523
|
+
/**
|
|
2524
|
+
* When `true` attempt content is included in the response.
|
|
2525
|
+
*
|
|
2526
|
+
* Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request without specifying this parameter.
|
|
2527
|
+
*/
|
|
2528
|
+
withContent?: boolean;
|
|
2529
|
+
/**
|
|
2530
|
+
* When `true`, the message information is included in the response
|
|
2531
|
+
*
|
|
2532
|
+
* Note that message payloads are never included in the response, regardless of this flag.
|
|
2533
|
+
*/
|
|
2534
|
+
withMsg?: boolean;
|
|
2535
|
+
/**
|
|
2536
|
+
* When `true`, return the Canceled (4) status in attempts.
|
|
2537
|
+
*
|
|
2538
|
+
* If `false`, canceled attempts are returned as Success (0) for backwards compatibility.
|
|
2539
|
+
*/
|
|
2540
|
+
expandedStatuses?: boolean;
|
|
2541
|
+
/** Filter response based on the event type */
|
|
2542
|
+
eventTypes?: string[];
|
|
2543
|
+
}
|
|
2544
|
+
interface MessageAttemptListByMsgOptions {
|
|
2545
|
+
/** Limit the number of returned items */
|
|
2546
|
+
limit?: number;
|
|
2547
|
+
/** The iterator returned from a prior invocation */
|
|
2548
|
+
iterator?: string | null;
|
|
2549
|
+
/** Filter response based on the status of the attempt: Success (0), Pending (1), Failed (2), Sending (3), or Canceled (4) */
|
|
2550
|
+
status?: MessageStatus;
|
|
2551
|
+
/** Filter response based on the HTTP status code */
|
|
2552
|
+
statusCodeClass?: StatusCodeClass;
|
|
2553
|
+
/** Filter response based on the channel */
|
|
2554
|
+
channel?: string;
|
|
2555
|
+
/** Filter response based on the tag */
|
|
2556
|
+
tag?: string;
|
|
2557
|
+
/** Filter the attempts based on the attempted endpoint */
|
|
2558
|
+
endpointId?: string;
|
|
2559
|
+
/** Only include items created before a certain date */
|
|
2560
|
+
before?: Date | null;
|
|
2561
|
+
/** Only include items created after a certain date */
|
|
2562
|
+
after?: Date | null;
|
|
2563
|
+
/**
|
|
2564
|
+
* When `true` attempt content is included in the response.
|
|
2565
|
+
*
|
|
2566
|
+
* Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request without specifying this parameter.
|
|
2567
|
+
*/
|
|
2568
|
+
withContent?: boolean;
|
|
2569
|
+
/**
|
|
2570
|
+
* When `true`, return the Canceled (4) status in attempts.
|
|
2571
|
+
*
|
|
2572
|
+
* If `false`, canceled attempts are returned as Success (0) for backwards compatibility.
|
|
2573
|
+
*/
|
|
2574
|
+
expandedStatuses?: boolean;
|
|
2575
|
+
/** Filter response based on the event type */
|
|
2576
|
+
eventTypes?: string[];
|
|
2577
|
+
}
|
|
2578
|
+
interface MessageAttemptListAttemptedMessagesOptions {
|
|
2579
|
+
/** Limit the number of returned items */
|
|
2580
|
+
limit?: number;
|
|
2581
|
+
/** The iterator returned from a prior invocation */
|
|
2582
|
+
iterator?: string | null;
|
|
2583
|
+
/** Filter response based on the channel */
|
|
2584
|
+
channel?: string;
|
|
2585
|
+
/** Filter response based on the message tags */
|
|
2586
|
+
tag?: string;
|
|
2587
|
+
/** Filter response based on the status of the attempt: Success (0), Pending (1), Failed (2), Sending (3), or Canceled (4) */
|
|
2588
|
+
status?: MessageStatus;
|
|
2589
|
+
/** Only include items created before a certain date */
|
|
2590
|
+
before?: Date | null;
|
|
2591
|
+
/** Only include items created after a certain date */
|
|
2592
|
+
after?: Date | null;
|
|
2593
|
+
/**
|
|
2594
|
+
* When `true` message payloads are included in the response.
|
|
2595
|
+
*
|
|
2596
|
+
* Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request without specifying this parameter.
|
|
2597
|
+
*/
|
|
2598
|
+
withContent?: boolean;
|
|
2599
|
+
/**
|
|
2600
|
+
* When `true`, return the Canceled (4) status in attempts.
|
|
2601
|
+
*
|
|
2602
|
+
* If `false`, canceled attempts are returned as Success (0) for backwards compatibility.
|
|
2603
|
+
*/
|
|
2604
|
+
expandedStatuses?: boolean;
|
|
2605
|
+
/** Filter response based on the event type */
|
|
2606
|
+
eventTypes?: string[];
|
|
2607
|
+
}
|
|
2608
|
+
interface MessageAttemptListAttemptedDestinationsOptions {
|
|
2609
|
+
/** Limit the number of returned items */
|
|
2610
|
+
limit?: number;
|
|
2611
|
+
/** The iterator returned from a prior invocation */
|
|
2612
|
+
iterator?: string | null;
|
|
2613
|
+
}
|
|
2614
|
+
interface MessageAttemptGetOptions {
|
|
2615
|
+
/**
|
|
2616
|
+
* When `true`, return the Canceled (4) status in attempts.
|
|
2617
|
+
*
|
|
2618
|
+
* If `false`, canceled attempts are returned as Success (0) for backwards compatibility.
|
|
2619
|
+
*/
|
|
2620
|
+
expandedStatuses?: boolean;
|
|
2621
|
+
}
|
|
2622
|
+
interface MessageAttemptResendOptions {
|
|
2623
|
+
idempotencyKey?: string;
|
|
2624
|
+
}
|
|
2625
|
+
declare class MessageAttempt {
|
|
2626
|
+
private readonly requestCtx;
|
|
2627
|
+
constructor(requestCtx: SvixRequestContext);
|
|
2628
|
+
/**
|
|
2629
|
+
* List attempts by endpoint id
|
|
2630
|
+
*
|
|
2631
|
+
* Note that by default this endpoint is limited to retrieving 90 days' worth of data
|
|
2632
|
+
* relative to now or, if an iterator is provided, 90 days before/after the time indicated
|
|
2633
|
+
* by the iterator ID. If you require data beyond those time ranges, you will need to explicitly
|
|
2634
|
+
* set the `before` or `after` parameter as appropriate.
|
|
2635
|
+
*/
|
|
2636
|
+
listByEndpoint(appId: string, endpointId: string, options?: MessageAttemptListByEndpointOptions): Promise<ListResponseMessageAttemptOut>;
|
|
2637
|
+
/**
|
|
2638
|
+
* List attempts by message ID.
|
|
2639
|
+
*
|
|
2640
|
+
* Note that by default this endpoint is limited to retrieving 90 days' worth of data
|
|
2641
|
+
* relative to now or, if an iterator is provided, 90 days before/after the time indicated
|
|
2642
|
+
* by the iterator ID. If you require data beyond those time ranges, you will need to explicitly
|
|
2643
|
+
* set the `before` or `after` parameter as appropriate.
|
|
2644
|
+
*/
|
|
2645
|
+
listByMsg(appId: string, msgId: string, options?: MessageAttemptListByMsgOptions): Promise<ListResponseMessageAttemptOut>;
|
|
2646
|
+
/**
|
|
2647
|
+
* List messages for a particular endpoint.
|
|
2648
|
+
*
|
|
2649
|
+
* Additionally includes metadata about the latest message attempt.
|
|
2650
|
+
* The `before` parameter lets you filter all items created before a certain date and is ignored if an iterator is passed.
|
|
2651
|
+
*
|
|
2652
|
+
* Note that by default this endpoint is limited to retrieving 90 days' worth of data
|
|
2653
|
+
* relative to now or, if an iterator is provided, 90 days before/after the time indicated
|
|
2654
|
+
* by the iterator ID. If you require data beyond those time ranges, you will need to explicitly
|
|
2655
|
+
* set the `before` or `after` parameter as appropriate.
|
|
2656
|
+
*/
|
|
2657
|
+
listAttemptedMessages(appId: string, endpointId: string, options?: MessageAttemptListAttemptedMessagesOptions): Promise<ListResponseEndpointMessageOut>;
|
|
2658
|
+
/**
|
|
2659
|
+
* List endpoints attempted by a given message.
|
|
2660
|
+
*
|
|
2661
|
+
* Additionally includes metadata about the latest message attempt.
|
|
2662
|
+
* By default, endpoints are listed in ascending order by ID.
|
|
2663
|
+
*/
|
|
2664
|
+
listAttemptedDestinations(appId: string, msgId: string, options?: MessageAttemptListAttemptedDestinationsOptions): Promise<ListResponseMessageEndpointOut>;
|
|
2665
|
+
/** `msg_id`: Use a message id or a message `eventId` */
|
|
2666
|
+
get(appId: string, msgId: string, attemptId: string, options?: MessageAttemptGetOptions): Promise<MessageAttemptOut>;
|
|
2667
|
+
/**
|
|
2668
|
+
* Deletes the given attempt's response body.
|
|
2669
|
+
*
|
|
2670
|
+
* Useful when an endpoint accidentally returned sensitive content.
|
|
2671
|
+
* The message can't be replayed or resent once its payload has been deleted or expired.
|
|
2672
|
+
*/
|
|
2673
|
+
expungeContent(appId: string, msgId: string, attemptId: string): Promise<void>;
|
|
2674
|
+
/** Resend a message to the specified endpoint. */
|
|
2675
|
+
resend(appId: string, msgId: string, endpointId: string, options?: MessageAttemptResendOptions): Promise<EmptyResponse>;
|
|
2676
|
+
}
|
|
2677
|
+
//#endregion
|
|
2678
|
+
//#region src/models/operationalWebhookEndpointOut.d.ts
|
|
2679
|
+
interface OperationalWebhookEndpointOut {
|
|
2680
|
+
/** The Endpoint's ID. */
|
|
2681
|
+
id: string;
|
|
2682
|
+
url: string;
|
|
2683
|
+
description: string;
|
|
2684
|
+
/**
|
|
2685
|
+
* Maximum messages per second to send to this endpoint.
|
|
2686
|
+
*
|
|
2687
|
+
* Outgoing messages will be throttled to this rate.
|
|
2688
|
+
*/
|
|
2689
|
+
throttleRate?: number | null;
|
|
2690
|
+
/** Optional unique identifier for the endpoint. */
|
|
2691
|
+
uid?: string | null;
|
|
2692
|
+
disabled?: boolean;
|
|
2693
|
+
eventTypes?: string[] | null;
|
|
2694
|
+
createdAt: Date;
|
|
2695
|
+
updatedAt: Date;
|
|
2696
|
+
metadata: {
|
|
2697
|
+
[key: string]: string;
|
|
2698
|
+
};
|
|
2699
|
+
}
|
|
2700
|
+
//#endregion
|
|
2701
|
+
//#region src/models/listResponseOperationalWebhookEndpointOut.d.ts
|
|
2702
|
+
interface ListResponseOperationalWebhookEndpointOut {
|
|
2703
|
+
data: OperationalWebhookEndpointOut[];
|
|
2704
|
+
iterator: string | null;
|
|
2705
|
+
prevIterator?: string | null;
|
|
2706
|
+
done: boolean;
|
|
2707
|
+
}
|
|
2708
|
+
//#endregion
|
|
2709
|
+
//#region src/models/operationalWebhookEndpointHeadersIn.d.ts
|
|
2710
|
+
interface OperationalWebhookEndpointHeadersIn {
|
|
2711
|
+
headers: {
|
|
2712
|
+
[key: string]: string;
|
|
2713
|
+
};
|
|
2714
|
+
}
|
|
2715
|
+
//#endregion
|
|
2716
|
+
//#region src/models/operationalWebhookEndpointHeadersOut.d.ts
|
|
2717
|
+
interface OperationalWebhookEndpointHeadersOut {
|
|
2718
|
+
headers: {
|
|
2719
|
+
[key: string]: string;
|
|
2720
|
+
};
|
|
2721
|
+
sensitive: string[];
|
|
2722
|
+
}
|
|
2723
|
+
//#endregion
|
|
2724
|
+
//#region src/models/operationalWebhookEndpointIn.d.ts
|
|
2725
|
+
interface OperationalWebhookEndpointIn {
|
|
2726
|
+
url: string;
|
|
2727
|
+
description?: string;
|
|
2728
|
+
/**
|
|
2729
|
+
* Maximum messages per second to send to this endpoint.
|
|
2730
|
+
*
|
|
2731
|
+
* Outgoing messages will be throttled to this rate.
|
|
2732
|
+
*/
|
|
2733
|
+
throttleRate?: number | null;
|
|
2734
|
+
/** Optional unique identifier for the endpoint. */
|
|
2735
|
+
uid?: string | null;
|
|
2736
|
+
disabled?: boolean;
|
|
2737
|
+
eventTypes?: string[] | null;
|
|
2738
|
+
/**
|
|
2739
|
+
* The endpoint's verification secret.
|
|
2740
|
+
*
|
|
2741
|
+
* Format: `base64` encoded random bytes optionally prefixed with `whsec_`.
|
|
2742
|
+
* It is recommended to not set this and let the server generate the secret.
|
|
2743
|
+
*/
|
|
2744
|
+
secret?: string | null;
|
|
2745
|
+
metadata?: {
|
|
2746
|
+
[key: string]: string;
|
|
2747
|
+
};
|
|
2748
|
+
headers?: {
|
|
2749
|
+
[key: string]: string;
|
|
2750
|
+
} | null;
|
|
2751
|
+
}
|
|
2752
|
+
//#endregion
|
|
2753
|
+
//#region src/models/operationalWebhookEndpointSecretIn.d.ts
|
|
2754
|
+
interface OperationalWebhookEndpointSecretIn {
|
|
2755
|
+
/**
|
|
2756
|
+
* The endpoint's verification secret.
|
|
2757
|
+
*
|
|
2758
|
+
* Format: `base64` encoded random bytes optionally prefixed with `whsec_`.
|
|
2759
|
+
* It is recommended to not set this and let the server generate the secret.
|
|
2760
|
+
*/
|
|
2761
|
+
key?: string | null;
|
|
2762
|
+
/**
|
|
2763
|
+
* How long the old secret will be valid for, in seconds.
|
|
2764
|
+
*
|
|
2765
|
+
* Valid values are between 0 (immediate expiry) and 7 days. The default is 24 hours.
|
|
2766
|
+
*/
|
|
2767
|
+
gracePeriodSeconds?: number | null;
|
|
2768
|
+
}
|
|
2769
|
+
//#endregion
|
|
2770
|
+
//#region src/models/operationalWebhookEndpointSecretOut.d.ts
|
|
2771
|
+
interface OperationalWebhookEndpointSecretOut {
|
|
2772
|
+
/**
|
|
2773
|
+
* The endpoint's verification secret.
|
|
2774
|
+
*
|
|
2775
|
+
* Format: `base64` encoded random bytes optionally prefixed with `whsec_`.
|
|
2776
|
+
* It is recommended to not set this and let the server generate the secret.
|
|
2777
|
+
*/
|
|
2778
|
+
key: string;
|
|
2779
|
+
}
|
|
2780
|
+
//#endregion
|
|
2781
|
+
//#region src/models/operationalWebhookEndpointUpsertIn.d.ts
|
|
2782
|
+
interface OperationalWebhookEndpointUpsertIn {
|
|
2783
|
+
url: string;
|
|
2784
|
+
description?: string;
|
|
2785
|
+
/**
|
|
2786
|
+
* Maximum messages per second to send to this endpoint.
|
|
2787
|
+
*
|
|
2788
|
+
* Outgoing messages will be throttled to this rate.
|
|
2789
|
+
*/
|
|
2790
|
+
throttleRate?: number | null;
|
|
2791
|
+
/** Optional unique identifier for the endpoint. */
|
|
2792
|
+
uid?: string | null;
|
|
2793
|
+
disabled?: boolean;
|
|
2794
|
+
eventTypes?: string[] | null;
|
|
2795
|
+
metadata?: {
|
|
2796
|
+
[key: string]: string;
|
|
2797
|
+
};
|
|
2798
|
+
}
|
|
2799
|
+
//#endregion
|
|
2800
|
+
//#region src/api/operationalWebhookEndpoint.d.ts
|
|
2801
|
+
interface OperationalWebhookEndpointListOptions {
|
|
2802
|
+
/** Limit the number of returned items */
|
|
2803
|
+
limit?: number;
|
|
2804
|
+
/** The iterator returned from a prior invocation */
|
|
2805
|
+
iterator?: string | null;
|
|
2806
|
+
/** The sorting order of the returned items */
|
|
2807
|
+
order?: Ordering;
|
|
2808
|
+
}
|
|
2809
|
+
interface OperationalWebhookEndpointCreateOptions {
|
|
2810
|
+
idempotencyKey?: string;
|
|
2811
|
+
}
|
|
2812
|
+
interface OperationalWebhookEndpointRotateSecretOptions {
|
|
2813
|
+
idempotencyKey?: string;
|
|
2814
|
+
}
|
|
2815
|
+
declare class OperationalWebhookEndpoint {
|
|
2816
|
+
private readonly requestCtx;
|
|
2817
|
+
constructor(requestCtx: SvixRequestContext);
|
|
2818
|
+
/** List operational webhook endpoints. */
|
|
2819
|
+
list(options?: OperationalWebhookEndpointListOptions): Promise<ListResponseOperationalWebhookEndpointOut>;
|
|
2820
|
+
/** Create an operational webhook endpoint. */
|
|
2821
|
+
create(operationalWebhookEndpointIn: OperationalWebhookEndpointIn, options?: OperationalWebhookEndpointCreateOptions): Promise<OperationalWebhookEndpointOut>;
|
|
2822
|
+
/** Get an operational webhook endpoint. */
|
|
2823
|
+
get(endpointId: string): Promise<OperationalWebhookEndpointOut>;
|
|
2824
|
+
/** Create or update an operational webhook endpoint. */
|
|
2825
|
+
upsert(endpointId: string, operationalWebhookEndpointUpsertIn: OperationalWebhookEndpointUpsertIn): Promise<OperationalWebhookEndpointOut>;
|
|
2826
|
+
/** Delete an operational webhook endpoint. */
|
|
2827
|
+
delete(endpointId: string): Promise<void>;
|
|
2828
|
+
/**
|
|
2829
|
+
* Get an operational webhook endpoint's signing secret.
|
|
2830
|
+
*
|
|
2831
|
+
* This is used to verify the authenticity of the webhook.
|
|
2832
|
+
* For more information please refer to [the consuming webhooks docs](https://docs.svix.com/consuming-webhooks/).
|
|
2833
|
+
*/
|
|
2834
|
+
getSecret(endpointId: string): Promise<OperationalWebhookEndpointSecretOut>;
|
|
2835
|
+
/**
|
|
2836
|
+
* Rotates an operational webhook endpoint's signing secret.
|
|
2837
|
+
*
|
|
2838
|
+
* The previous secret will remain valid for the specified grace period (default 24 hours).
|
|
2839
|
+
*/
|
|
2840
|
+
rotateSecret(endpointId: string, operationalWebhookEndpointSecretIn?: OperationalWebhookEndpointSecretIn, options?: OperationalWebhookEndpointRotateSecretOptions): Promise<void>;
|
|
2841
|
+
/** Get the additional headers to be sent with the operational webhook. */
|
|
2842
|
+
getHeaders(endpointId: string): Promise<OperationalWebhookEndpointHeadersOut>;
|
|
2843
|
+
/** Set the additional headers to be sent with the operational webhook. */
|
|
2844
|
+
setHeaders(endpointId: string, operationalWebhookEndpointHeadersIn: OperationalWebhookEndpointHeadersIn): Promise<void>;
|
|
2845
|
+
}
|
|
2846
|
+
//#endregion
|
|
2847
|
+
//#region src/api/operationalWebhook.d.ts
|
|
2848
|
+
declare class OperationalWebhook {
|
|
2849
|
+
private readonly requestCtx;
|
|
2850
|
+
constructor(requestCtx: SvixRequestContext);
|
|
2851
|
+
get endpoint(): OperationalWebhookEndpoint;
|
|
2852
|
+
}
|
|
2853
|
+
//#endregion
|
|
2854
|
+
//#region src/models/aggregateEventTypesOut.d.ts
|
|
2855
|
+
interface AggregateEventTypesOut {
|
|
2856
|
+
/** The QueueBackgroundTask's ID. */
|
|
2857
|
+
id: string;
|
|
2858
|
+
status: BackgroundTaskStatus;
|
|
2859
|
+
task: BackgroundTaskType;
|
|
2860
|
+
updatedAt: Date;
|
|
2861
|
+
}
|
|
2862
|
+
//#endregion
|
|
2863
|
+
//#region src/models/appUsageStatsIn.d.ts
|
|
2864
|
+
interface AppUsageStatsIn {
|
|
2865
|
+
since: Date;
|
|
2866
|
+
until: Date;
|
|
2867
|
+
/**
|
|
2868
|
+
* Specific app IDs or UIDs to aggregate stats for.
|
|
2869
|
+
*
|
|
2870
|
+
* Note that if none of the given IDs or UIDs are resolved, a 422 response will be given.
|
|
2871
|
+
*/
|
|
2872
|
+
appIds?: string[] | null;
|
|
2873
|
+
}
|
|
2874
|
+
//#endregion
|
|
2875
|
+
//#region src/models/appUsageStatsOut.d.ts
|
|
2876
|
+
interface AppUsageStatsOut {
|
|
2877
|
+
/**
|
|
2878
|
+
* Any app IDs or UIDs received in the request that weren't found.
|
|
2879
|
+
*
|
|
2880
|
+
* Stats will be produced for all the others.
|
|
2881
|
+
*/
|
|
2882
|
+
unresolvedAppIds: string[];
|
|
2883
|
+
/** The QueueBackgroundTask's ID. */
|
|
2884
|
+
id: string;
|
|
2885
|
+
status: BackgroundTaskStatus;
|
|
2886
|
+
task: BackgroundTaskType;
|
|
2887
|
+
updatedAt: Date;
|
|
2888
|
+
}
|
|
2889
|
+
//#endregion
|
|
2890
|
+
//#region src/api/statistics.d.ts
|
|
2891
|
+
interface StatisticsAggregateAppStatsOptions {
|
|
2892
|
+
idempotencyKey?: string;
|
|
2893
|
+
}
|
|
2894
|
+
declare class Statistics {
|
|
2895
|
+
private readonly requestCtx;
|
|
2896
|
+
constructor(requestCtx: SvixRequestContext);
|
|
2897
|
+
/**
|
|
2898
|
+
* Creates a background task to calculate the listed event types for all apps in the organization.
|
|
2899
|
+
*
|
|
2900
|
+
* Note that this endpoint is asynchronous. You will need to poll the `Get Background Task` endpoint to
|
|
2901
|
+
* retrieve the results of the operation.
|
|
2902
|
+
*
|
|
2903
|
+
* The completed background task will return a payload like the following:
|
|
2904
|
+
* ```json
|
|
2905
|
+
* {
|
|
2906
|
+
* "id": "qtask_33qe39Stble9Rn3ZxFrqL5ZSsjT",
|
|
2907
|
+
* "status": "finished",
|
|
2908
|
+
* "task": "event-type.aggregate",
|
|
2909
|
+
* "data": {
|
|
2910
|
+
* "event_types": [
|
|
2911
|
+
* {
|
|
2912
|
+
* "appId": "app_33W1An2Zz5cO9SWbhHsYyDmVC6m",
|
|
2913
|
+
* "explicitlySubscribedEventTypes": ["user.signup", "user.deleted"],
|
|
2914
|
+
* "hasCatchAllEndpoint": false
|
|
2915
|
+
* }
|
|
2916
|
+
* ]
|
|
2917
|
+
* }
|
|
2918
|
+
* }
|
|
2919
|
+
* ```
|
|
2920
|
+
*/
|
|
2921
|
+
aggregateEventTypes(): Promise<AggregateEventTypesOut>;
|
|
2922
|
+
/**
|
|
2923
|
+
* Creates a background task to calculate the number of message attempts (`messageDestinations`) made for all applications in the environment.
|
|
2924
|
+
*
|
|
2925
|
+
* Note that this endpoint is asynchronous. You will need to poll the `Get Background Task` endpoint to
|
|
2926
|
+
* retrieve the results of the operation.
|
|
2927
|
+
*
|
|
2928
|
+
* The completed background task will return a payload like the following:
|
|
2929
|
+
* ```json
|
|
2930
|
+
* {
|
|
2931
|
+
* "id": "qtask_33qe39Stble9Rn3ZxFrqL5ZSsjT",
|
|
2932
|
+
* "status": "finished",
|
|
2933
|
+
* "task": "application.stats",
|
|
2934
|
+
* "data": {
|
|
2935
|
+
* "appStats": [
|
|
2936
|
+
* {
|
|
2937
|
+
* "messageDestinations": 2,
|
|
2938
|
+
* "appId": "app_33W1An2Zz5cO9SWbhHsYyDmVC6m",
|
|
2939
|
+
* "appUid": null
|
|
2940
|
+
* }
|
|
2941
|
+
* ]
|
|
2942
|
+
* }
|
|
2943
|
+
* }
|
|
2944
|
+
* ```
|
|
2945
|
+
*/
|
|
2946
|
+
aggregateAppStats(appUsageStatsIn: AppUsageStatsIn, options?: StatisticsAggregateAppStatsOptions): Promise<AppUsageStatsOut>;
|
|
2947
|
+
}
|
|
2948
|
+
//#endregion
|
|
2949
|
+
//#region src/models/httpSinkHeadersPatchIn.d.ts
|
|
2950
|
+
interface HttpSinkHeadersPatchIn {
|
|
2951
|
+
headers: {
|
|
2952
|
+
[key: string]: string;
|
|
2953
|
+
};
|
|
2954
|
+
}
|
|
2955
|
+
//#endregion
|
|
2956
|
+
//#region src/models/streamEventTypeOut.d.ts
|
|
2957
|
+
interface StreamEventTypeOut {
|
|
2958
|
+
/** The event type's name */
|
|
2959
|
+
name: string;
|
|
2960
|
+
description?: string | null;
|
|
2961
|
+
createdAt: Date;
|
|
2962
|
+
updatedAt: Date;
|
|
2963
|
+
deprecated: boolean;
|
|
2964
|
+
archived: boolean;
|
|
2965
|
+
featureFlags?: string[] | null;
|
|
2966
|
+
}
|
|
2967
|
+
//#endregion
|
|
2968
|
+
//#region src/models/listResponseStreamEventTypeOut.d.ts
|
|
2969
|
+
interface ListResponseStreamEventTypeOut {
|
|
2970
|
+
data: StreamEventTypeOut[];
|
|
2971
|
+
iterator: string | null;
|
|
2972
|
+
prevIterator?: string | null;
|
|
2973
|
+
done: boolean;
|
|
2974
|
+
}
|
|
2975
|
+
//#endregion
|
|
2976
|
+
//#region src/models/streamEventTypeIn.d.ts
|
|
2977
|
+
interface StreamEventTypeIn {
|
|
2978
|
+
/** The event type's name */
|
|
2979
|
+
name: string;
|
|
2980
|
+
description?: string | null;
|
|
2981
|
+
featureFlags?: string[] | null;
|
|
2982
|
+
deprecated?: boolean;
|
|
2983
|
+
archived?: boolean;
|
|
2984
|
+
}
|
|
2985
|
+
//#endregion
|
|
2986
|
+
//#region src/models/streamEventTypePatch.d.ts
|
|
2987
|
+
interface StreamEventTypePatch {
|
|
2988
|
+
description?: string | null;
|
|
2989
|
+
featureFlags?: string[] | null;
|
|
2990
|
+
deprecated?: boolean;
|
|
2991
|
+
archived?: boolean;
|
|
2992
|
+
}
|
|
2993
|
+
//#endregion
|
|
2994
|
+
//#region src/api/streamingEventType.d.ts
|
|
2995
|
+
interface StreamingEventTypeListOptions {
|
|
2996
|
+
/** Limit the number of returned items */
|
|
2997
|
+
limit?: number;
|
|
2998
|
+
/** The iterator returned from a prior invocation */
|
|
2999
|
+
iterator?: string | null;
|
|
3000
|
+
/** The sorting order of the returned items */
|
|
3001
|
+
order?: Ordering;
|
|
3002
|
+
/** Include archived (deleted but not expunged) items in the response. */
|
|
3003
|
+
includeArchived?: boolean;
|
|
3004
|
+
}
|
|
3005
|
+
interface StreamingEventTypeCreateOptions {
|
|
3006
|
+
idempotencyKey?: string;
|
|
3007
|
+
}
|
|
3008
|
+
interface StreamingEventTypeDeleteOptions {
|
|
3009
|
+
/** By default, event types are archived when "deleted". With this flag, they are deleted entirely. */
|
|
3010
|
+
expunge?: boolean;
|
|
3011
|
+
}
|
|
3012
|
+
declare class StreamingEventType {
|
|
3013
|
+
private readonly requestCtx;
|
|
3014
|
+
constructor(requestCtx: SvixRequestContext);
|
|
3015
|
+
/** List of all the organization's event types for streaming. */
|
|
3016
|
+
list(options?: StreamingEventTypeListOptions): Promise<ListResponseStreamEventTypeOut>;
|
|
3017
|
+
/** Create an event type for Streams. */
|
|
3018
|
+
create(streamEventTypeIn: StreamEventTypeIn, options?: StreamingEventTypeCreateOptions): Promise<StreamEventTypeOut>;
|
|
3019
|
+
/** Get an event type. */
|
|
3020
|
+
get(name: string): Promise<StreamEventTypeOut>;
|
|
3021
|
+
/** Create or update or create a event type for Streams. */
|
|
3022
|
+
upsert(name: string, streamEventTypeIn: StreamEventTypeIn): Promise<StreamEventTypeOut>;
|
|
3023
|
+
/** Delete an event type. */
|
|
3024
|
+
delete(name: string, options?: StreamingEventTypeDeleteOptions): Promise<void>;
|
|
3025
|
+
/** Patch an event type for Streams. */
|
|
3026
|
+
patch(name: string, streamEventTypePatch: StreamEventTypePatch): Promise<StreamEventTypeOut>;
|
|
3027
|
+
}
|
|
3028
|
+
//#endregion
|
|
3029
|
+
//#region src/models/eventIn.d.ts
|
|
3030
|
+
interface EventIn {
|
|
3031
|
+
/** The event type's name */
|
|
3032
|
+
eventType: string;
|
|
3033
|
+
payload: string;
|
|
3034
|
+
}
|
|
3035
|
+
//#endregion
|
|
3036
|
+
//#region src/models/streamIn.d.ts
|
|
3037
|
+
interface StreamIn {
|
|
3038
|
+
/** The stream's name. */
|
|
3039
|
+
name: string;
|
|
3040
|
+
/** An optional unique identifier for the stream. */
|
|
3041
|
+
uid?: string | null;
|
|
3042
|
+
metadata?: {
|
|
3043
|
+
[key: string]: string;
|
|
3044
|
+
};
|
|
3045
|
+
}
|
|
3046
|
+
//#endregion
|
|
3047
|
+
//#region src/models/createStreamEventsIn.d.ts
|
|
3048
|
+
interface CreateStreamEventsIn {
|
|
3049
|
+
events: EventIn[];
|
|
3050
|
+
/**
|
|
3051
|
+
* Optionally creates a new Stream alongside the events.
|
|
3052
|
+
*
|
|
3053
|
+
* If the stream id or uid that is used in the path already exists, this argument is ignored.
|
|
3054
|
+
*/
|
|
3055
|
+
stream?: StreamIn | null;
|
|
3056
|
+
}
|
|
3057
|
+
//#endregion
|
|
3058
|
+
//#region src/models/createStreamEventsOut.d.ts
|
|
3059
|
+
interface CreateStreamEventsOut {}
|
|
3060
|
+
//#endregion
|
|
3061
|
+
//#region src/models/eventOut.d.ts
|
|
3062
|
+
interface EventOut {
|
|
3063
|
+
/** The event type's name */
|
|
3064
|
+
eventType: string;
|
|
3065
|
+
payload: string;
|
|
3066
|
+
timestamp: Date;
|
|
3067
|
+
}
|
|
3068
|
+
//#endregion
|
|
3069
|
+
//#region src/models/eventStreamOut.d.ts
|
|
3070
|
+
interface EventStreamOut {
|
|
3071
|
+
data: EventOut[];
|
|
3072
|
+
iterator: string;
|
|
3073
|
+
done: boolean;
|
|
3074
|
+
}
|
|
3075
|
+
//#endregion
|
|
3076
|
+
//#region src/api/streamingEvents.d.ts
|
|
3077
|
+
interface StreamingEventsGetOptions {
|
|
3078
|
+
/** Limit the number of returned items */
|
|
3079
|
+
limit?: number;
|
|
3080
|
+
/** The iterator returned from a prior invocation */
|
|
3081
|
+
iterator?: string | null;
|
|
3082
|
+
after?: Date | null;
|
|
3083
|
+
}
|
|
3084
|
+
interface StreamingEventsCreateOptions {
|
|
3085
|
+
idempotencyKey?: string;
|
|
3086
|
+
}
|
|
3087
|
+
declare class StreamingEvents {
|
|
3088
|
+
private readonly requestCtx;
|
|
3089
|
+
constructor(requestCtx: SvixRequestContext);
|
|
3090
|
+
/**
|
|
3091
|
+
* Iterate over a stream of events.
|
|
3092
|
+
*
|
|
3093
|
+
* The sink must be of type `poller` to use the poller endpoint.
|
|
3094
|
+
*/
|
|
3095
|
+
get(streamId: string, sinkId: string, options?: StreamingEventsGetOptions): Promise<EventStreamOut>;
|
|
3096
|
+
/** Creates events on the Stream. */
|
|
3097
|
+
create(streamId: string, createStreamEventsIn: CreateStreamEventsIn, options?: StreamingEventsCreateOptions): Promise<CreateStreamEventsOut>;
|
|
3098
|
+
}
|
|
3099
|
+
//#endregion
|
|
3100
|
+
//#region src/models/azureBlobStorageConfigOut.d.ts
|
|
3101
|
+
interface AzureBlobStorageConfigOut {
|
|
3102
|
+
container: string;
|
|
3103
|
+
account: string;
|
|
3104
|
+
}
|
|
3105
|
+
//#endregion
|
|
3106
|
+
//#region src/models/bigQueryConfigOut.d.ts
|
|
3107
|
+
interface BigQueryConfigOut {
|
|
3108
|
+
projectId: string;
|
|
3109
|
+
datasetId: string;
|
|
3110
|
+
tableId: string;
|
|
3111
|
+
}
|
|
3112
|
+
//#endregion
|
|
3113
|
+
//#region src/models/clickhouseConfigOut.d.ts
|
|
3114
|
+
interface ClickhouseConfigOut {
|
|
3115
|
+
url: string;
|
|
3116
|
+
username: string;
|
|
3117
|
+
database: string;
|
|
3118
|
+
tableName: string;
|
|
3119
|
+
}
|
|
3120
|
+
//#endregion
|
|
3121
|
+
//#region src/models/eventBridgeConfigOut.d.ts
|
|
3122
|
+
interface EventBridgeConfigOut {
|
|
3123
|
+
eventBusName: string;
|
|
3124
|
+
detailType: string;
|
|
3125
|
+
accessKeyId: string;
|
|
3126
|
+
region: string;
|
|
3127
|
+
}
|
|
3128
|
+
//#endregion
|
|
3129
|
+
//#region src/models/googleCloudPubSubConfigOut.d.ts
|
|
3130
|
+
interface GoogleCloudPubSubConfigOut {
|
|
3131
|
+
projectId: string;
|
|
3132
|
+
topicId: string;
|
|
3133
|
+
}
|
|
3134
|
+
//#endregion
|
|
3135
|
+
//#region src/models/googleCloudStorageConfigOut.d.ts
|
|
3136
|
+
interface GoogleCloudStorageConfigOut {
|
|
3137
|
+
bucket: string;
|
|
3138
|
+
}
|
|
3139
|
+
//#endregion
|
|
3140
|
+
//#region src/models/otelTracingConfigOut.d.ts
|
|
3141
|
+
interface OtelTracingConfigOut {
|
|
3142
|
+
url: string;
|
|
3143
|
+
headers: EndpointHeadersOut;
|
|
3144
|
+
}
|
|
3145
|
+
//#endregion
|
|
3146
|
+
//#region src/models/rabbitMqConfigOut.d.ts
|
|
3147
|
+
interface RabbitMqConfigOut {
|
|
3148
|
+
routingKey: string;
|
|
3149
|
+
}
|
|
3150
|
+
//#endregion
|
|
3151
|
+
//#region src/models/redshiftConfigOut.d.ts
|
|
3152
|
+
interface RedshiftConfigOut {
|
|
3153
|
+
accessKeyId: string;
|
|
3154
|
+
region: string;
|
|
3155
|
+
clusterIdentifier?: string | null;
|
|
3156
|
+
dbUser?: string | null;
|
|
3157
|
+
workgroupName?: string | null;
|
|
3158
|
+
/**
|
|
3159
|
+
* Database name.
|
|
3160
|
+
*
|
|
3161
|
+
* Only required if not using transformations.
|
|
3162
|
+
*/
|
|
3163
|
+
dbName?: string;
|
|
3164
|
+
/**
|
|
3165
|
+
* Schema name.
|
|
3166
|
+
*
|
|
3167
|
+
* Only used if not using transformations.
|
|
3168
|
+
*/
|
|
3169
|
+
schemaName?: string | null;
|
|
3170
|
+
/**
|
|
3171
|
+
* Table name.
|
|
3172
|
+
*
|
|
3173
|
+
* Only required if not using transformations.
|
|
3174
|
+
*/
|
|
3175
|
+
tableName?: string;
|
|
3176
|
+
}
|
|
3177
|
+
//#endregion
|
|
3178
|
+
//#region src/models/s3ConfigOut.d.ts
|
|
3179
|
+
interface S3ConfigOut {
|
|
3180
|
+
bucket: string;
|
|
3181
|
+
accessKeyId: string;
|
|
3182
|
+
region: string;
|
|
3183
|
+
endpointUrl?: string | null;
|
|
3184
|
+
}
|
|
3185
|
+
//#endregion
|
|
3186
|
+
//#region src/models/sinkHttpConfigOut.d.ts
|
|
3187
|
+
interface SinkHttpConfigOut {
|
|
3188
|
+
url: string;
|
|
3189
|
+
headers: EndpointHeadersOut;
|
|
3190
|
+
}
|
|
3191
|
+
//#endregion
|
|
3192
|
+
//#region src/models/sinkStatus.d.ts
|
|
3193
|
+
declare enum SinkStatus {
|
|
3194
|
+
Enabled = "enabled",
|
|
3195
|
+
Paused = "paused",
|
|
3196
|
+
Disabled = "disabled",
|
|
3197
|
+
Retrying = "retrying"
|
|
3198
|
+
}
|
|
3199
|
+
//#endregion
|
|
3200
|
+
//#region src/models/snowflakeConfigOut.d.ts
|
|
3201
|
+
interface SnowflakeConfigOut {
|
|
3202
|
+
accountIdentifier: string;
|
|
3203
|
+
userId: string;
|
|
3204
|
+
/**
|
|
3205
|
+
* Database name.
|
|
3206
|
+
*
|
|
3207
|
+
* Only required if not using transformations.
|
|
3208
|
+
*/
|
|
3209
|
+
dbName?: string;
|
|
3210
|
+
/**
|
|
3211
|
+
* Schema name.
|
|
3212
|
+
*
|
|
3213
|
+
* Only required if not using transformations.
|
|
3214
|
+
*/
|
|
3215
|
+
schemaName?: string;
|
|
3216
|
+
/**
|
|
3217
|
+
* Table name.
|
|
3218
|
+
*
|
|
3219
|
+
* Only required if not using transformations.
|
|
3220
|
+
*/
|
|
3221
|
+
tableName?: string;
|
|
3222
|
+
}
|
|
3223
|
+
//#endregion
|
|
3224
|
+
//#region src/models/snsConfigOut.d.ts
|
|
3225
|
+
interface SnsConfigOut {
|
|
3226
|
+
topicArn: string;
|
|
3227
|
+
region: string;
|
|
3228
|
+
accessKeyId: string;
|
|
3229
|
+
}
|
|
3230
|
+
//#endregion
|
|
3231
|
+
//#region src/models/sqsConfigOut.d.ts
|
|
3232
|
+
interface SqsConfigOut {
|
|
3233
|
+
queueUrl: string;
|
|
3234
|
+
region: string;
|
|
3235
|
+
accessKeyId: string;
|
|
3236
|
+
endpointUrl?: string | null;
|
|
3237
|
+
}
|
|
3238
|
+
//#endregion
|
|
3239
|
+
//#region src/models/streamSinkOut.d.ts
|
|
3240
|
+
interface _StreamSinkOutFields {
|
|
3241
|
+
/** The sink's ID. */
|
|
3242
|
+
id: string;
|
|
3243
|
+
/** The sink's UID. */
|
|
3244
|
+
uid?: string | null;
|
|
3245
|
+
status: SinkStatus;
|
|
3246
|
+
currentIterator: string;
|
|
3247
|
+
failureReason?: string | null;
|
|
3248
|
+
createdAt: Date;
|
|
3249
|
+
updatedAt: Date;
|
|
3250
|
+
batchSize: number;
|
|
3251
|
+
maxWaitSecs: number;
|
|
3252
|
+
eventTypes?: string[];
|
|
3253
|
+
channels?: string[];
|
|
3254
|
+
nextRetryAt?: Date | null;
|
|
3255
|
+
metadata: {
|
|
3256
|
+
[key: string]: string;
|
|
3257
|
+
};
|
|
3258
|
+
}
|
|
3259
|
+
interface StreamSinkOutPollerConfig {}
|
|
3260
|
+
interface StreamSinkOutPoller {
|
|
3261
|
+
type: "poller";
|
|
3262
|
+
config?: StreamSinkOutPollerConfig;
|
|
3263
|
+
}
|
|
3264
|
+
interface StreamSinkOutAzureBlobStorage {
|
|
3265
|
+
type: "azureBlobStorage";
|
|
3266
|
+
config: AzureBlobStorageConfigOut;
|
|
3267
|
+
}
|
|
3268
|
+
interface StreamSinkOutOtelTracing {
|
|
3269
|
+
type: "otelTracing";
|
|
3270
|
+
config: OtelTracingConfigOut;
|
|
3271
|
+
}
|
|
3272
|
+
interface StreamSinkOutHttp {
|
|
3273
|
+
type: "http";
|
|
3274
|
+
config: SinkHttpConfigOut;
|
|
3275
|
+
}
|
|
3276
|
+
interface StreamSinkOutAmazonS3 {
|
|
3277
|
+
type: "amazonS3";
|
|
3278
|
+
config: S3ConfigOut;
|
|
3279
|
+
}
|
|
3280
|
+
interface StreamSinkOutSnowflake {
|
|
3281
|
+
type: "snowflake";
|
|
3282
|
+
config: SnowflakeConfigOut;
|
|
3283
|
+
}
|
|
3284
|
+
interface StreamSinkOutGoogleCloudStorage {
|
|
3285
|
+
type: "googleCloudStorage";
|
|
3286
|
+
config: GoogleCloudStorageConfigOut;
|
|
3287
|
+
}
|
|
3288
|
+
interface StreamSinkOutGoogleCloudPubSub {
|
|
3289
|
+
type: "googleCloudPubSub";
|
|
3290
|
+
config: GoogleCloudPubSubConfigOut;
|
|
3291
|
+
}
|
|
3292
|
+
interface StreamSinkOutRedshift {
|
|
3293
|
+
type: "redshift";
|
|
3294
|
+
config: RedshiftConfigOut;
|
|
3295
|
+
}
|
|
3296
|
+
interface StreamSinkOutBigQuery {
|
|
3297
|
+
type: "bigQuery";
|
|
3298
|
+
config: BigQueryConfigOut;
|
|
3299
|
+
}
|
|
3300
|
+
interface StreamSinkOutClickhouse {
|
|
3301
|
+
type: "clickhouse";
|
|
3302
|
+
config: ClickhouseConfigOut;
|
|
3303
|
+
}
|
|
3304
|
+
interface StreamSinkOutRabbitMq {
|
|
3305
|
+
type: "rabbitMq";
|
|
3306
|
+
config: RabbitMqConfigOut;
|
|
3307
|
+
}
|
|
3308
|
+
interface StreamSinkOutSqs {
|
|
3309
|
+
type: "sqs";
|
|
3310
|
+
config: SqsConfigOut;
|
|
3311
|
+
}
|
|
3312
|
+
interface StreamSinkOutEventBridge {
|
|
3313
|
+
type: "eventBridge";
|
|
3314
|
+
config: EventBridgeConfigOut;
|
|
3315
|
+
}
|
|
3316
|
+
interface StreamSinkOutSns {
|
|
3317
|
+
type: "sns";
|
|
3318
|
+
config: SnsConfigOut;
|
|
3319
|
+
}
|
|
3320
|
+
type StreamSinkOut = _StreamSinkOutFields & (StreamSinkOutPoller | StreamSinkOutAzureBlobStorage | StreamSinkOutOtelTracing | StreamSinkOutHttp | StreamSinkOutAmazonS3 | StreamSinkOutSnowflake | StreamSinkOutGoogleCloudStorage | StreamSinkOutGoogleCloudPubSub | StreamSinkOutRedshift | StreamSinkOutBigQuery | StreamSinkOutClickhouse | StreamSinkOutRabbitMq | StreamSinkOutSqs | StreamSinkOutEventBridge | StreamSinkOutSns);
|
|
3321
|
+
//#endregion
|
|
3322
|
+
//#region src/models/listResponseStreamSinkOut.d.ts
|
|
3323
|
+
interface ListResponseStreamSinkOut {
|
|
3324
|
+
data: StreamSinkOut[];
|
|
3325
|
+
iterator: string | null;
|
|
3326
|
+
prevIterator?: string | null;
|
|
3327
|
+
done: boolean;
|
|
3328
|
+
}
|
|
3329
|
+
//#endregion
|
|
3330
|
+
//#region src/models/sinkSecretOut.d.ts
|
|
3331
|
+
interface SinkSecretOut {
|
|
3332
|
+
/**
|
|
3333
|
+
* The endpoint's verification secret.
|
|
3334
|
+
*
|
|
3335
|
+
* Format: `base64` encoded random bytes optionally prefixed with `whsec_`.
|
|
3336
|
+
* It is recommended to not set this and let the server generate the secret.
|
|
3337
|
+
*/
|
|
3338
|
+
key?: string | null;
|
|
3339
|
+
}
|
|
3340
|
+
//#endregion
|
|
3341
|
+
//#region src/models/azureBlobStorageConfigIn.d.ts
|
|
3342
|
+
interface AzureBlobStorageConfigIn {
|
|
3343
|
+
container: string;
|
|
3344
|
+
account: string;
|
|
3345
|
+
/**
|
|
3346
|
+
* Access key.
|
|
3347
|
+
*
|
|
3348
|
+
* Currently a required field, but marked as optional because we may add different authentication in the future.
|
|
3349
|
+
*/
|
|
3350
|
+
accessKey?: string | null;
|
|
3351
|
+
}
|
|
3352
|
+
//#endregion
|
|
3353
|
+
//#region src/models/bigQueryConfigIn.d.ts
|
|
3354
|
+
/** Configuration for a Google Cloud BigQuery sink. */
|
|
3355
|
+
interface BigQueryConfigIn {
|
|
3356
|
+
projectId: string;
|
|
3357
|
+
datasetId: string;
|
|
3358
|
+
tableId: string;
|
|
3359
|
+
/** Google Cloud Credentials JSON Object as a string. */
|
|
3360
|
+
credentials: string;
|
|
3361
|
+
}
|
|
3362
|
+
//#endregion
|
|
3363
|
+
//#region src/models/clickhouseConfigIn.d.ts
|
|
3364
|
+
interface ClickhouseConfigIn {
|
|
3365
|
+
/** The HTTP URL of the ClickHouse server (e.g. `https://my_clickhouse:8443`). */
|
|
3366
|
+
url: string;
|
|
3367
|
+
/**
|
|
3368
|
+
* Username to access Clickhouse.
|
|
3369
|
+
*
|
|
3370
|
+
* Currently a required field, but marked as optional because we may add different authentication in the future.
|
|
3371
|
+
*/
|
|
3372
|
+
username?: string | null;
|
|
3373
|
+
/**
|
|
3374
|
+
* Password to access Clickhouse.
|
|
3375
|
+
*
|
|
3376
|
+
* Currently a required field, but marked as optional because we may add different authentication in the future.
|
|
3377
|
+
*/
|
|
3378
|
+
password?: string | null;
|
|
3379
|
+
/** The Clickhouse database to connect to. */
|
|
3380
|
+
database?: string;
|
|
3381
|
+
/** The Clickhouse table to write to. */
|
|
3382
|
+
tableName: string;
|
|
3383
|
+
}
|
|
3384
|
+
//#endregion
|
|
3385
|
+
//#region src/models/eventBridgeConfigIn.d.ts
|
|
3386
|
+
interface EventBridgeConfigIn {
|
|
3387
|
+
/** The name or ARN of the event bus to receive the event */
|
|
3388
|
+
eventBusName: string;
|
|
3389
|
+
/** Free-form string, with a maximum of 128 characters */
|
|
3390
|
+
detailType?: string;
|
|
3391
|
+
/**
|
|
3392
|
+
* Access key ID.
|
|
3393
|
+
*
|
|
3394
|
+
* Currently a required field, but marked as optional because we may add different authentication in the future.
|
|
3395
|
+
*/
|
|
3396
|
+
accessKeyId?: string | null;
|
|
3397
|
+
/**
|
|
3398
|
+
* Secret access key.
|
|
3399
|
+
*
|
|
3400
|
+
* Currently a required field, but marked as optional because we may add different authentication in the future.
|
|
3401
|
+
*/
|
|
3402
|
+
secretAccessKey?: string | null;
|
|
3403
|
+
/**
|
|
3404
|
+
* The region of the EventBridge bus.
|
|
3405
|
+
*
|
|
3406
|
+
* Currently a required field, but marked as optional because we may infer it from other fields in the future.
|
|
3407
|
+
*/
|
|
3408
|
+
region?: string | null;
|
|
3409
|
+
}
|
|
3410
|
+
//#endregion
|
|
3411
|
+
//#region src/models/googleCloudPubSubConfigIn.d.ts
|
|
3412
|
+
interface GoogleCloudPubSubConfigIn {
|
|
3413
|
+
projectId: string;
|
|
3414
|
+
topicId: string;
|
|
3415
|
+
/** Google Cloud Credentials JSON Object as a string. */
|
|
3416
|
+
credentials: string;
|
|
3417
|
+
}
|
|
3418
|
+
//#endregion
|
|
3419
|
+
//#region src/models/googleCloudStorageConfigIn.d.ts
|
|
3420
|
+
/**
|
|
3421
|
+
* Configuration for a Google Cloud Storage sink.
|
|
3422
|
+
*
|
|
3423
|
+
* Write stream events into the named bucket using the supplied Google Cloud credentials.
|
|
3424
|
+
*/
|
|
3425
|
+
interface GoogleCloudStorageConfigIn {
|
|
3426
|
+
bucket: string;
|
|
3427
|
+
/** Google Cloud Credentials JSON Object as a string. */
|
|
3428
|
+
credentials: string;
|
|
3429
|
+
}
|
|
3430
|
+
//#endregion
|
|
3431
|
+
//#region src/models/otelTracingConfigIn.d.ts
|
|
3432
|
+
interface OtelTracingConfigIn {
|
|
3433
|
+
url: string;
|
|
3434
|
+
headers?: {
|
|
3435
|
+
[key: string]: string;
|
|
3436
|
+
};
|
|
3437
|
+
}
|
|
3438
|
+
//#endregion
|
|
3439
|
+
//#region src/models/rabbitMqConfigIn.d.ts
|
|
3440
|
+
/** Configuration for a RabbitMq sink. */
|
|
3441
|
+
interface RabbitMqConfigIn {
|
|
3442
|
+
uri: string;
|
|
3443
|
+
routingKey: string;
|
|
3444
|
+
}
|
|
3445
|
+
//#endregion
|
|
3446
|
+
//#region src/models/redshiftConfigIn.d.ts
|
|
3447
|
+
/**
|
|
3448
|
+
* Configuration parameters for defining a Redshift sink.
|
|
3449
|
+
*
|
|
3450
|
+
* For provisioned clusters, set `cluster_identifier` and `db_user`. For Redshift Serverless, set `workgroup_name`.
|
|
3451
|
+
*/
|
|
3452
|
+
interface RedshiftConfigIn {
|
|
3453
|
+
/**
|
|
3454
|
+
* Access key ID.
|
|
3455
|
+
*
|
|
3456
|
+
* Currently a required field, but marked as optional because we may add different authentication in the future.
|
|
3457
|
+
*/
|
|
3458
|
+
accessKeyId?: string | null;
|
|
3459
|
+
/**
|
|
3460
|
+
* Secret access key.
|
|
3461
|
+
*
|
|
3462
|
+
* Currently a required field, but marked as optional because we may add different authentication in the future.
|
|
3463
|
+
*/
|
|
3464
|
+
secretAccessKey?: string | null;
|
|
3465
|
+
/**
|
|
3466
|
+
* The region of the Redshift DB.
|
|
3467
|
+
*
|
|
3468
|
+
* Currently a required field, but marked as optional because we may infer it from other fields in the future.
|
|
3469
|
+
*/
|
|
3470
|
+
region?: string | null;
|
|
3471
|
+
/** Required for provisioned clusters. */
|
|
3472
|
+
clusterIdentifier?: string | null;
|
|
3473
|
+
/** Required for provisioned clusters. */
|
|
3474
|
+
dbUser?: string | null;
|
|
3475
|
+
/** Required for Redshift Serverless. */
|
|
3476
|
+
workgroupName?: string | null;
|
|
3477
|
+
/**
|
|
3478
|
+
* Database name.
|
|
3479
|
+
*
|
|
3480
|
+
* Only required if not using transformations.
|
|
3481
|
+
*/
|
|
3482
|
+
dbName?: string;
|
|
3483
|
+
/**
|
|
3484
|
+
* Schema name.
|
|
3485
|
+
*
|
|
3486
|
+
* Only used if not using transformations.
|
|
3487
|
+
*/
|
|
3488
|
+
schemaName?: string | null;
|
|
3489
|
+
/**
|
|
3490
|
+
* Table name.
|
|
3491
|
+
*
|
|
3492
|
+
* Only required if not using transformations.
|
|
3493
|
+
*/
|
|
3494
|
+
tableName?: string;
|
|
3495
|
+
}
|
|
3496
|
+
//#endregion
|
|
3497
|
+
//#region src/models/s3ConfigIn.d.ts
|
|
3498
|
+
interface S3ConfigIn {
|
|
3499
|
+
bucket: string;
|
|
3500
|
+
/**
|
|
3501
|
+
* Access key ID.
|
|
3502
|
+
*
|
|
3503
|
+
* Currently a required field, but marked as optional because we may add different authentication in the future.
|
|
3504
|
+
*/
|
|
3505
|
+
accessKeyId?: string | null;
|
|
3506
|
+
/**
|
|
3507
|
+
* Secret access key.
|
|
3508
|
+
*
|
|
3509
|
+
* Currently a required field, but marked as optional because we may add different authentication in the future.
|
|
3510
|
+
*/
|
|
3511
|
+
secretAccessKey?: string | null;
|
|
3512
|
+
/**
|
|
3513
|
+
* The region of the EventBridge bus.
|
|
3514
|
+
*
|
|
3515
|
+
* Currently a required field, but marked as optional because we may infer it from other fields in the future.
|
|
3516
|
+
*/
|
|
3517
|
+
region?: string | null;
|
|
3518
|
+
endpointUrl?: string | null;
|
|
3519
|
+
}
|
|
3520
|
+
//#endregion
|
|
3521
|
+
//#region src/models/sinkHttpConfigIn.d.ts
|
|
3522
|
+
interface SinkHttpConfigIn {
|
|
3523
|
+
url: string;
|
|
3524
|
+
headers?: {
|
|
3525
|
+
[key: string]: string;
|
|
3526
|
+
};
|
|
3527
|
+
key?: string | null;
|
|
3528
|
+
}
|
|
3529
|
+
//#endregion
|
|
3530
|
+
//#region src/models/sinkStatusIn.d.ts
|
|
3531
|
+
declare enum SinkStatusIn {
|
|
3532
|
+
Enabled = "enabled",
|
|
3533
|
+
Disabled = "disabled"
|
|
3534
|
+
}
|
|
3535
|
+
//#endregion
|
|
3536
|
+
//#region src/models/snowflakeConfigIn.d.ts
|
|
3537
|
+
/** Configuration parameters for defining a Snowflake sink. */
|
|
3538
|
+
interface SnowflakeConfigIn {
|
|
3539
|
+
/**
|
|
3540
|
+
* PEM-encoded private key used for signing token-based requests to the Snowflake API.
|
|
3541
|
+
*
|
|
3542
|
+
* Beginning/end delimiters are not required.
|
|
3543
|
+
*
|
|
3544
|
+
* Currently a required field, but marked as optional because we may add different authentication in the future.
|
|
3545
|
+
*/
|
|
3546
|
+
privateKey?: string | null;
|
|
3547
|
+
/** Snowflake account identifier, which includes both the organization and account IDs separated by a hyphen. */
|
|
3548
|
+
accountIdentifier: string;
|
|
3549
|
+
/** The Snowflake user id. */
|
|
3550
|
+
userId: string;
|
|
3551
|
+
/**
|
|
3552
|
+
* Database name.
|
|
3553
|
+
*
|
|
3554
|
+
* Only required if not using transformations.
|
|
3555
|
+
*/
|
|
3556
|
+
dbName?: string;
|
|
3557
|
+
/**
|
|
3558
|
+
* Schema name.
|
|
3559
|
+
*
|
|
3560
|
+
* Only required if not using transformations.
|
|
3561
|
+
*/
|
|
3562
|
+
schemaName?: string;
|
|
3563
|
+
/**
|
|
3564
|
+
* Table name.
|
|
3565
|
+
*
|
|
3566
|
+
* Only required if not using transformations.
|
|
3567
|
+
*/
|
|
3568
|
+
tableName?: string;
|
|
3569
|
+
}
|
|
3570
|
+
//#endregion
|
|
3571
|
+
//#region src/models/snsConfigIn.d.ts
|
|
3572
|
+
/** Configuration for a SNS sink. */
|
|
3573
|
+
interface SnsConfigIn {
|
|
3574
|
+
topicArn: string;
|
|
3575
|
+
/**
|
|
3576
|
+
* The region of the SNS instance.
|
|
3577
|
+
*
|
|
3578
|
+
* Currently a required field, but marked as optional because we may infer it from other fields in the future.
|
|
3579
|
+
*/
|
|
3580
|
+
region?: string | null;
|
|
3581
|
+
/**
|
|
3582
|
+
* Access key ID.
|
|
3583
|
+
*
|
|
3584
|
+
* Currently a required field, but marked as optional because we may add different authentication in the future.
|
|
3585
|
+
*/
|
|
3586
|
+
accessKeyId?: string | null;
|
|
3587
|
+
/**
|
|
3588
|
+
* Secret access key.
|
|
3589
|
+
*
|
|
3590
|
+
* Currently a required field, but marked as optional because we may add different authentication in the future.
|
|
3591
|
+
*/
|
|
3592
|
+
secretAccessKey?: string | null;
|
|
3593
|
+
endpointUrl?: string | null;
|
|
3594
|
+
}
|
|
3595
|
+
//#endregion
|
|
3596
|
+
//#region src/models/sqsConfigIn.d.ts
|
|
3597
|
+
/** Configuration for an SQS sink. */
|
|
3598
|
+
interface SqsConfigIn {
|
|
3599
|
+
queueUrl: string;
|
|
3600
|
+
/**
|
|
3601
|
+
* The region of the SQS queue.
|
|
3602
|
+
*
|
|
3603
|
+
* Currently a required field, but marked as optional because we may infer it from other fields in the future.
|
|
3604
|
+
*/
|
|
3605
|
+
region?: string | null;
|
|
3606
|
+
/**
|
|
3607
|
+
* Access key ID.
|
|
3608
|
+
*
|
|
3609
|
+
* Currently a required field, but marked as optional because we may add different authentication in the future.
|
|
3610
|
+
*/
|
|
3611
|
+
accessKeyId?: string | null;
|
|
3612
|
+
/**
|
|
3613
|
+
* Secret access key.
|
|
3614
|
+
*
|
|
3615
|
+
* Currently a required field, but marked as optional because we may add different authentication in the future.
|
|
3616
|
+
*/
|
|
3617
|
+
secretAccessKey?: string | null;
|
|
3618
|
+
endpointUrl?: string | null;
|
|
3619
|
+
}
|
|
3620
|
+
//#endregion
|
|
3621
|
+
//#region src/models/streamSinkIn.d.ts
|
|
3622
|
+
interface _StreamSinkInFields {
|
|
3623
|
+
/** An optional unique identifier for the sink. */
|
|
3624
|
+
uid?: string | null;
|
|
3625
|
+
/**
|
|
3626
|
+
* Whether the sink will receive events.
|
|
3627
|
+
*
|
|
3628
|
+
* If the sink is `enabled`, any events posted to the stream will be dispatched to the Sink in the same order that events were posted to the stream.
|
|
3629
|
+
*
|
|
3630
|
+
* If the sink is `disabled`, events will not be dispatched to the sink until the sink is reenabled.
|
|
3631
|
+
*/
|
|
3632
|
+
status?: SinkStatusIn;
|
|
3633
|
+
/** How many events will be batched in a request to the Sink. */
|
|
3634
|
+
batchSize?: number;
|
|
3635
|
+
/**
|
|
3636
|
+
* How long to wait before a batch of events is sent, if the `batchSize` is not reached.
|
|
3637
|
+
*
|
|
3638
|
+
* For example, with a `batchSize` of 100 and `maxWaitSecs` of 10, we will send a request after 10 seconds or 100 events, whichever comes first.
|
|
3639
|
+
*
|
|
3640
|
+
* Note that we will never send an empty batch of events to the Sink.
|
|
3641
|
+
*/
|
|
3642
|
+
maxWaitSecs?: number;
|
|
3643
|
+
/** A list of event types that filter which events are dispatched to the Sink. An empty list (or null) will not filter out any events. */
|
|
3644
|
+
eventTypes?: string[];
|
|
3645
|
+
channels?: string[];
|
|
3646
|
+
metadata?: {
|
|
3647
|
+
[key: string]: string;
|
|
3648
|
+
};
|
|
3649
|
+
}
|
|
3650
|
+
interface StreamSinkInPollerConfig {}
|
|
3651
|
+
interface StreamSinkInPoller {
|
|
3652
|
+
type: "poller";
|
|
3653
|
+
config?: StreamSinkInPollerConfig;
|
|
3654
|
+
}
|
|
3655
|
+
interface StreamSinkInAzureBlobStorage {
|
|
3656
|
+
type: "azureBlobStorage";
|
|
3657
|
+
config: AzureBlobStorageConfigIn;
|
|
3658
|
+
}
|
|
3659
|
+
interface StreamSinkInOtelTracing {
|
|
3660
|
+
type: "otelTracing";
|
|
3661
|
+
config: OtelTracingConfigIn;
|
|
3662
|
+
}
|
|
3663
|
+
interface StreamSinkInHttp {
|
|
3664
|
+
type: "http";
|
|
3665
|
+
config: SinkHttpConfigIn;
|
|
3666
|
+
}
|
|
3667
|
+
interface StreamSinkInAmazonS3 {
|
|
3668
|
+
type: "amazonS3";
|
|
3669
|
+
config: S3ConfigIn;
|
|
3670
|
+
}
|
|
3671
|
+
interface StreamSinkInGoogleCloudStorage {
|
|
3672
|
+
type: "googleCloudStorage";
|
|
3673
|
+
config: GoogleCloudStorageConfigIn;
|
|
3674
|
+
}
|
|
3675
|
+
interface StreamSinkInGoogleCloudPubSub {
|
|
3676
|
+
type: "googleCloudPubSub";
|
|
3677
|
+
config: GoogleCloudPubSubConfigIn;
|
|
3678
|
+
}
|
|
3679
|
+
interface StreamSinkInSqs {
|
|
3680
|
+
type: "sqs";
|
|
3681
|
+
config: SqsConfigIn;
|
|
3682
|
+
}
|
|
3683
|
+
interface StreamSinkInSns {
|
|
3684
|
+
type: "sns";
|
|
3685
|
+
config: SnsConfigIn;
|
|
3686
|
+
}
|
|
3687
|
+
interface StreamSinkInBigQuery {
|
|
3688
|
+
type: "bigQuery";
|
|
3689
|
+
config: BigQueryConfigIn;
|
|
3690
|
+
}
|
|
3691
|
+
interface StreamSinkInClickhouse {
|
|
3692
|
+
type: "clickhouse";
|
|
3693
|
+
config: ClickhouseConfigIn;
|
|
3694
|
+
}
|
|
3695
|
+
interface StreamSinkInEventBridge {
|
|
3696
|
+
type: "eventBridge";
|
|
3697
|
+
config: EventBridgeConfigIn;
|
|
3698
|
+
}
|
|
3699
|
+
interface StreamSinkInSnowflake {
|
|
3700
|
+
type: "snowflake";
|
|
3701
|
+
config: SnowflakeConfigIn;
|
|
3702
|
+
}
|
|
3703
|
+
interface StreamSinkInRabbitMq {
|
|
3704
|
+
type: "rabbitMq";
|
|
3705
|
+
config: RabbitMqConfigIn;
|
|
3706
|
+
}
|
|
3707
|
+
interface StreamSinkInRedshift {
|
|
3708
|
+
type: "redshift";
|
|
3709
|
+
config: RedshiftConfigIn;
|
|
3710
|
+
}
|
|
3711
|
+
type StreamSinkIn = _StreamSinkInFields & (StreamSinkInPoller | StreamSinkInAzureBlobStorage | StreamSinkInOtelTracing | StreamSinkInHttp | StreamSinkInAmazonS3 | StreamSinkInGoogleCloudStorage | StreamSinkInGoogleCloudPubSub | StreamSinkInSqs | StreamSinkInSns | StreamSinkInBigQuery | StreamSinkInClickhouse | StreamSinkInEventBridge | StreamSinkInSnowflake | StreamSinkInRabbitMq | StreamSinkInRedshift);
|
|
3712
|
+
//#endregion
|
|
3713
|
+
//#region src/models/azureBlobStorageConfigPatch.d.ts
|
|
3714
|
+
interface AzureBlobStorageConfigPatch {
|
|
3715
|
+
container?: string;
|
|
3716
|
+
account?: string;
|
|
3717
|
+
accessKey?: string;
|
|
3718
|
+
}
|
|
3719
|
+
//#endregion
|
|
3720
|
+
//#region src/models/bigQueryConfigPatch.d.ts
|
|
3721
|
+
interface BigQueryConfigPatch {
|
|
3722
|
+
projectId?: string;
|
|
3723
|
+
datasetId?: string;
|
|
3724
|
+
tableId?: string;
|
|
3725
|
+
credentials?: string;
|
|
3726
|
+
}
|
|
3727
|
+
//#endregion
|
|
3728
|
+
//#region src/models/clickhouseConfigPatch.d.ts
|
|
3729
|
+
interface ClickhouseConfigPatch {
|
|
3730
|
+
url?: string;
|
|
3731
|
+
username?: string;
|
|
3732
|
+
password?: string;
|
|
3733
|
+
database?: string;
|
|
3734
|
+
tableName?: string;
|
|
3735
|
+
}
|
|
3736
|
+
//#endregion
|
|
3737
|
+
//#region src/models/eventBridgeConfigPatch.d.ts
|
|
3738
|
+
interface EventBridgeConfigPatch {
|
|
3739
|
+
eventBusName?: string;
|
|
3740
|
+
detailType?: string;
|
|
3741
|
+
accessKeyId?: string;
|
|
3742
|
+
secretAccessKey?: string;
|
|
3743
|
+
region?: string;
|
|
3744
|
+
}
|
|
3745
|
+
//#endregion
|
|
3746
|
+
//#region src/models/googleCloudPubSubConfigPatch.d.ts
|
|
3747
|
+
interface GoogleCloudPubSubConfigPatch {
|
|
3748
|
+
projectId?: string;
|
|
3749
|
+
topicId?: string;
|
|
3750
|
+
credentials?: string;
|
|
3751
|
+
}
|
|
3752
|
+
//#endregion
|
|
3753
|
+
//#region src/models/googleCloudStorageConfigPatch.d.ts
|
|
3754
|
+
interface GoogleCloudStorageConfigPatch {
|
|
3755
|
+
bucket?: string;
|
|
3756
|
+
credentials?: string;
|
|
3757
|
+
}
|
|
3758
|
+
//#endregion
|
|
3759
|
+
//#region src/models/otelTracingConfigPatch.d.ts
|
|
3760
|
+
interface OtelTracingConfigPatch {
|
|
3761
|
+
url?: string;
|
|
3762
|
+
}
|
|
3763
|
+
//#endregion
|
|
3764
|
+
//#region src/models/rabbitMqConfigPatch.d.ts
|
|
3765
|
+
interface RabbitMqConfigPatch {
|
|
3766
|
+
routingKey?: string;
|
|
3767
|
+
uri?: string;
|
|
3768
|
+
}
|
|
3769
|
+
//#endregion
|
|
3770
|
+
//#region src/models/redshiftConfigPatch.d.ts
|
|
3771
|
+
interface RedshiftConfigPatch {
|
|
3772
|
+
accessKeyId?: string;
|
|
3773
|
+
secretAccessKey?: string;
|
|
3774
|
+
region?: string;
|
|
3775
|
+
/**
|
|
3776
|
+
* Database name.
|
|
3777
|
+
*
|
|
3778
|
+
* Only required if not using transformations.
|
|
3779
|
+
*/
|
|
3780
|
+
dbName?: string;
|
|
3781
|
+
/**
|
|
3782
|
+
* Schema name.
|
|
3783
|
+
*
|
|
3784
|
+
* Only used if not using transformations.
|
|
3785
|
+
*/
|
|
3786
|
+
schemaName?: string | null;
|
|
3787
|
+
/**
|
|
3788
|
+
* Table name.
|
|
3789
|
+
*
|
|
3790
|
+
* Only required if not using transformations.
|
|
3791
|
+
*/
|
|
3792
|
+
tableName?: string;
|
|
3793
|
+
}
|
|
3794
|
+
//#endregion
|
|
3795
|
+
//#region src/models/s3ConfigPatch.d.ts
|
|
3796
|
+
interface S3ConfigPatch {
|
|
3797
|
+
bucket?: string;
|
|
3798
|
+
accessKeyId?: string;
|
|
3799
|
+
secretAccessKey?: string;
|
|
3800
|
+
region?: string;
|
|
3801
|
+
endpointUrl?: string;
|
|
3802
|
+
}
|
|
3803
|
+
//#endregion
|
|
3804
|
+
//#region src/models/sinkHttpConfigPatch.d.ts
|
|
3805
|
+
interface SinkHttpConfigPatch {
|
|
3806
|
+
url?: string;
|
|
3807
|
+
}
|
|
3808
|
+
//#endregion
|
|
3809
|
+
//#region src/models/snowflakeConfigPatch.d.ts
|
|
3810
|
+
interface SnowflakeConfigPatch {
|
|
3811
|
+
privateKey?: string;
|
|
3812
|
+
accountIdentifier?: string;
|
|
3813
|
+
userId?: string;
|
|
3814
|
+
/**
|
|
3815
|
+
* Database name.
|
|
3816
|
+
*
|
|
3817
|
+
* Only required if not using transformations.
|
|
3818
|
+
*/
|
|
3819
|
+
dbName?: string;
|
|
3820
|
+
/**
|
|
3821
|
+
* Schema name.
|
|
3822
|
+
*
|
|
3823
|
+
* Only required if not using transformations.
|
|
3824
|
+
*/
|
|
3825
|
+
schemaName?: string;
|
|
3826
|
+
/**
|
|
3827
|
+
* Table name.
|
|
3828
|
+
*
|
|
3829
|
+
* Only required if not using transformations.
|
|
3830
|
+
*/
|
|
3831
|
+
tableName?: string;
|
|
3832
|
+
}
|
|
3833
|
+
//#endregion
|
|
3834
|
+
//#region src/models/snsConfigPatch.d.ts
|
|
3835
|
+
interface SnsConfigPatch {
|
|
3836
|
+
topicArn?: string;
|
|
3837
|
+
region?: string;
|
|
3838
|
+
accessKeyId?: string;
|
|
3839
|
+
secretAccessKey?: string;
|
|
3840
|
+
endpointUrl?: string | null;
|
|
3841
|
+
}
|
|
3842
|
+
//#endregion
|
|
3843
|
+
//#region src/models/sqsConfigPatch.d.ts
|
|
3844
|
+
interface SqsConfigPatch {
|
|
3845
|
+
queueUrl?: string;
|
|
3846
|
+
region?: string;
|
|
3847
|
+
accessKeyId?: string;
|
|
3848
|
+
secretAccessKey?: string;
|
|
3849
|
+
endpointUrl?: string | null;
|
|
3850
|
+
}
|
|
3851
|
+
//#endregion
|
|
3852
|
+
//#region src/models/streamSinkPatch.d.ts
|
|
3853
|
+
interface _StreamSinkPatchFields {
|
|
3854
|
+
/** The StreamSink's UID. */
|
|
3855
|
+
uid?: string | null;
|
|
3856
|
+
status?: SinkStatusIn | null;
|
|
3857
|
+
batchSize?: number | null;
|
|
3858
|
+
maxWaitSecs?: number | null;
|
|
3859
|
+
eventTypes?: string[];
|
|
3860
|
+
channels?: string[];
|
|
3861
|
+
metadata?: {
|
|
3862
|
+
[key: string]: string;
|
|
3863
|
+
};
|
|
3864
|
+
}
|
|
3865
|
+
interface StreamSinkPatchPollerConfig {}
|
|
3866
|
+
interface StreamSinkPatchPoller {
|
|
3867
|
+
type: "poller";
|
|
3868
|
+
config?: StreamSinkPatchPollerConfig;
|
|
3869
|
+
}
|
|
3870
|
+
interface StreamSinkPatchAzureBlobStorage {
|
|
3871
|
+
type: "azureBlobStorage";
|
|
3872
|
+
config: AzureBlobStorageConfigPatch;
|
|
3873
|
+
}
|
|
3874
|
+
interface StreamSinkPatchOtelTracing {
|
|
3875
|
+
type: "otelTracing";
|
|
3876
|
+
config: OtelTracingConfigPatch;
|
|
3877
|
+
}
|
|
3878
|
+
interface StreamSinkPatchHttp {
|
|
3879
|
+
type: "http";
|
|
3880
|
+
config: SinkHttpConfigPatch;
|
|
3881
|
+
}
|
|
3882
|
+
interface StreamSinkPatchAmazonS3 {
|
|
3883
|
+
type: "amazonS3";
|
|
3884
|
+
config: S3ConfigPatch;
|
|
3885
|
+
}
|
|
3886
|
+
interface StreamSinkPatchGoogleCloudStorage {
|
|
3887
|
+
type: "googleCloudStorage";
|
|
3888
|
+
config: GoogleCloudStorageConfigPatch;
|
|
3889
|
+
}
|
|
3890
|
+
interface StreamSinkPatchGoogleCloudPubSub {
|
|
3891
|
+
type: "googleCloudPubSub";
|
|
3892
|
+
config: GoogleCloudPubSubConfigPatch;
|
|
3893
|
+
}
|
|
3894
|
+
interface StreamSinkPatchSqs {
|
|
3895
|
+
type: "sqs";
|
|
3896
|
+
config: SqsConfigPatch;
|
|
3897
|
+
}
|
|
3898
|
+
interface StreamSinkPatchSns {
|
|
3899
|
+
type: "sns";
|
|
3900
|
+
config: SnsConfigPatch;
|
|
3901
|
+
}
|
|
3902
|
+
interface StreamSinkPatchBigQuery {
|
|
3903
|
+
type: "bigQuery";
|
|
3904
|
+
config: BigQueryConfigPatch;
|
|
3905
|
+
}
|
|
3906
|
+
interface StreamSinkPatchClickhouse {
|
|
3907
|
+
type: "clickhouse";
|
|
3908
|
+
config: ClickhouseConfigPatch;
|
|
3909
|
+
}
|
|
3910
|
+
interface StreamSinkPatchEventBridge {
|
|
3911
|
+
type: "eventBridge";
|
|
3912
|
+
config: EventBridgeConfigPatch;
|
|
3913
|
+
}
|
|
3914
|
+
interface StreamSinkPatchSnowflake {
|
|
3915
|
+
type: "snowflake";
|
|
3916
|
+
config: SnowflakeConfigPatch;
|
|
3917
|
+
}
|
|
3918
|
+
interface StreamSinkPatchRabbitMq {
|
|
3919
|
+
type: "rabbitMq";
|
|
3920
|
+
config: RabbitMqConfigPatch;
|
|
3921
|
+
}
|
|
3922
|
+
interface StreamSinkPatchRedshift {
|
|
3923
|
+
type: "redshift";
|
|
3924
|
+
config: RedshiftConfigPatch;
|
|
3925
|
+
}
|
|
3926
|
+
type StreamSinkPatch = _StreamSinkPatchFields & (StreamSinkPatchPoller | StreamSinkPatchAzureBlobStorage | StreamSinkPatchOtelTracing | StreamSinkPatchHttp | StreamSinkPatchAmazonS3 | StreamSinkPatchGoogleCloudStorage | StreamSinkPatchGoogleCloudPubSub | StreamSinkPatchSqs | StreamSinkPatchSns | StreamSinkPatchBigQuery | StreamSinkPatchClickhouse | StreamSinkPatchEventBridge | StreamSinkPatchSnowflake | StreamSinkPatchRabbitMq | StreamSinkPatchRedshift);
|
|
3927
|
+
//#endregion
|
|
3928
|
+
//#region src/models/sinkTransformIn.d.ts
|
|
3929
|
+
interface SinkTransformIn {
|
|
3930
|
+
code?: string | null;
|
|
3931
|
+
}
|
|
3932
|
+
//#endregion
|
|
3933
|
+
//#region src/models/sinkTransformationOut.d.ts
|
|
3934
|
+
interface SinkTransformationOut {
|
|
3935
|
+
code?: string | null;
|
|
3936
|
+
enabled: boolean;
|
|
3937
|
+
}
|
|
3938
|
+
//#endregion
|
|
3939
|
+
//#region src/api/streamingSinkTransformation.d.ts
|
|
3940
|
+
declare class StreamingSinkTransformation {
|
|
3941
|
+
private readonly requestCtx;
|
|
3942
|
+
constructor(requestCtx: SvixRequestContext);
|
|
3943
|
+
/** Get the transformation code associated with this sink. */
|
|
3944
|
+
get(streamId: string, sinkId: string): Promise<SinkTransformationOut>;
|
|
3945
|
+
/** Set or unset the transformation code associated with this sink. */
|
|
3946
|
+
patch(streamId: string, sinkId: string, sinkTransformIn?: SinkTransformIn): Promise<EmptyResponse>;
|
|
3947
|
+
}
|
|
3948
|
+
//#endregion
|
|
3949
|
+
//#region src/api/streamingSink.d.ts
|
|
3950
|
+
interface StreamingSinkListOptions {
|
|
3951
|
+
/** Limit the number of returned items */
|
|
3952
|
+
limit?: number;
|
|
3953
|
+
/** The iterator returned from a prior invocation */
|
|
3954
|
+
iterator?: string | null;
|
|
3955
|
+
/** The sorting order of the returned items */
|
|
3956
|
+
order?: Ordering;
|
|
3957
|
+
}
|
|
3958
|
+
interface StreamingSinkCreateOptions {
|
|
3959
|
+
idempotencyKey?: string;
|
|
3960
|
+
}
|
|
3961
|
+
interface StreamingSinkRotateSecretOptions {
|
|
3962
|
+
idempotencyKey?: string;
|
|
3963
|
+
}
|
|
3964
|
+
declare class StreamingSink {
|
|
3965
|
+
private readonly requestCtx;
|
|
3966
|
+
constructor(requestCtx: SvixRequestContext);
|
|
3967
|
+
get transformation(): StreamingSinkTransformation;
|
|
3968
|
+
/** List of all the stream's sinks. */
|
|
3969
|
+
list(streamId: string, options?: StreamingSinkListOptions): Promise<ListResponseStreamSinkOut>;
|
|
3970
|
+
/** Creates a new sink. */
|
|
3971
|
+
create(streamId: string, streamSinkIn: StreamSinkIn, options?: StreamingSinkCreateOptions): Promise<StreamSinkOut>;
|
|
3972
|
+
/** Get a sink by id or uid. */
|
|
3973
|
+
get(streamId: string, sinkId: string): Promise<StreamSinkOut>;
|
|
3974
|
+
/** Create or update a sink. */
|
|
3975
|
+
upsert(streamId: string, sinkId: string, streamSinkIn: StreamSinkIn): Promise<StreamSinkOut>;
|
|
3976
|
+
/** Delete a sink. */
|
|
3977
|
+
delete(streamId: string, sinkId: string): Promise<void>;
|
|
3978
|
+
/** Partially update a sink. */
|
|
3979
|
+
patch(streamId: string, sinkId: string, streamSinkPatch: StreamSinkPatch): Promise<StreamSinkOut>;
|
|
3980
|
+
/**
|
|
3981
|
+
* Get the sink's signing secret (only supported for http sinks)
|
|
3982
|
+
*
|
|
3983
|
+
* This is used to verify the authenticity of the delivery.
|
|
3984
|
+
*
|
|
3985
|
+
* For more information please refer to [the consuming webhooks docs](https://docs.svix.com/consuming-webhooks/).
|
|
3986
|
+
*/
|
|
3987
|
+
getSecret(streamId: string, sinkId: string): Promise<SinkSecretOut>;
|
|
3988
|
+
/** Rotates the signing secret (only supported for http sinks). */
|
|
3989
|
+
rotateSecret(streamId: string, sinkId: string, endpointSecretRotateIn?: EndpointSecretRotateIn, options?: StreamingSinkRotateSecretOptions): Promise<EmptyResponse>;
|
|
3990
|
+
}
|
|
3991
|
+
//#endregion
|
|
3992
|
+
//#region src/models/streamOut.d.ts
|
|
3993
|
+
interface StreamOut {
|
|
3994
|
+
/** The stream's ID. */
|
|
3995
|
+
id: string;
|
|
3996
|
+
/** The stream's UID. */
|
|
3997
|
+
uid?: string | null;
|
|
3998
|
+
/** The stream's name. */
|
|
3999
|
+
name?: string | null;
|
|
4000
|
+
createdAt: Date;
|
|
4001
|
+
updatedAt: Date;
|
|
4002
|
+
metadata: {
|
|
4003
|
+
[key: string]: string;
|
|
4004
|
+
};
|
|
4005
|
+
}
|
|
4006
|
+
//#endregion
|
|
4007
|
+
//#region src/models/listResponseStreamOut.d.ts
|
|
4008
|
+
interface ListResponseStreamOut {
|
|
4009
|
+
data: StreamOut[];
|
|
4010
|
+
iterator: string | null;
|
|
4011
|
+
prevIterator?: string | null;
|
|
4012
|
+
done: boolean;
|
|
4013
|
+
}
|
|
4014
|
+
//#endregion
|
|
4015
|
+
//#region src/models/streamPatch.d.ts
|
|
4016
|
+
interface StreamPatch {
|
|
4017
|
+
/** The Stream's description. */
|
|
4018
|
+
description?: string;
|
|
4019
|
+
/** An optional unique identifier for the stream. */
|
|
4020
|
+
uid?: string | null;
|
|
4021
|
+
metadata?: {
|
|
4022
|
+
[key: string]: string;
|
|
4023
|
+
};
|
|
4024
|
+
}
|
|
4025
|
+
//#endregion
|
|
4026
|
+
//#region src/api/streamingStream.d.ts
|
|
4027
|
+
interface StreamingStreamListOptions {
|
|
4028
|
+
/** Limit the number of returned items */
|
|
4029
|
+
limit?: number;
|
|
4030
|
+
/** The iterator returned from a prior invocation */
|
|
4031
|
+
iterator?: string | null;
|
|
4032
|
+
/** The sorting order of the returned items */
|
|
4033
|
+
order?: Ordering;
|
|
4034
|
+
}
|
|
4035
|
+
interface StreamingStreamCreateOptions {
|
|
4036
|
+
idempotencyKey?: string;
|
|
4037
|
+
}
|
|
4038
|
+
declare class StreamingStream {
|
|
4039
|
+
private readonly requestCtx;
|
|
4040
|
+
constructor(requestCtx: SvixRequestContext);
|
|
4041
|
+
/** List of all the organization's streams. */
|
|
4042
|
+
list(options?: StreamingStreamListOptions): Promise<ListResponseStreamOut>;
|
|
4043
|
+
/** Creates a new stream. */
|
|
4044
|
+
create(streamIn: StreamIn, options?: StreamingStreamCreateOptions): Promise<StreamOut>;
|
|
4045
|
+
/** Get a stream by id or uid. */
|
|
4046
|
+
get(streamId: string): Promise<StreamOut>;
|
|
4047
|
+
/** Create or update a stream. */
|
|
4048
|
+
upsert(streamId: string, streamIn: StreamIn): Promise<StreamOut>;
|
|
4049
|
+
/** Delete a stream. */
|
|
4050
|
+
delete(streamId: string): Promise<void>;
|
|
4051
|
+
/** Partially update a stream. */
|
|
4052
|
+
patch(streamId: string, streamPatch: StreamPatch): Promise<StreamOut>;
|
|
4053
|
+
}
|
|
4054
|
+
//#endregion
|
|
4055
|
+
//#region src/api/streaming.d.ts
|
|
4056
|
+
declare class Streaming {
|
|
4057
|
+
private readonly requestCtx;
|
|
4058
|
+
constructor(requestCtx: SvixRequestContext);
|
|
4059
|
+
get eventType(): StreamingEventType;
|
|
4060
|
+
get events(): StreamingEvents;
|
|
4061
|
+
get sink(): StreamingSink;
|
|
4062
|
+
get stream(): StreamingStream;
|
|
4063
|
+
/**
|
|
4064
|
+
* Get the HTTP sink headers.
|
|
4065
|
+
*
|
|
4066
|
+
* Only valid for `http` or `otelTracing` sinks.
|
|
4067
|
+
*/
|
|
4068
|
+
sinkHeadersGet(streamId: string, sinkId: string): Promise<EndpointHeadersOut>;
|
|
4069
|
+
/**
|
|
4070
|
+
* Updates the Sink's headers.
|
|
4071
|
+
*
|
|
4072
|
+
* Only valid for `http` or `otelTracing` sinks.
|
|
4073
|
+
*/
|
|
4074
|
+
sinkHeadersPatch(streamId: string, sinkId: string, httpSinkHeadersPatchIn: HttpSinkHeadersPatchIn): Promise<EndpointHeadersOut>;
|
|
4075
|
+
}
|
|
4076
|
+
//#endregion
|
|
4077
|
+
//#region src/HttpErrors.d.ts
|
|
4078
|
+
declare class HttpErrorOut {
|
|
4079
|
+
code: string;
|
|
4080
|
+
detail: string;
|
|
4081
|
+
static readonly discriminator: string | undefined;
|
|
4082
|
+
static readonly mapping: {
|
|
4083
|
+
[index: string]: string;
|
|
4084
|
+
} | undefined;
|
|
4085
|
+
static readonly attributeTypeMap: Array<{
|
|
4086
|
+
name: string;
|
|
4087
|
+
baseName: string;
|
|
4088
|
+
type: string;
|
|
4089
|
+
format: string;
|
|
4090
|
+
}>;
|
|
4091
|
+
static getAttributeTypeMap(): {
|
|
4092
|
+
name: string;
|
|
4093
|
+
baseName: string;
|
|
4094
|
+
type: string;
|
|
4095
|
+
format: string;
|
|
4096
|
+
}[];
|
|
4097
|
+
}
|
|
4098
|
+
/**
|
|
4099
|
+
* Validation errors have their own schema to provide context for invalid requests eg. mismatched types and out of bounds values. There may be any number of these per 422 UNPROCESSABLE ENTITY error.
|
|
4100
|
+
*/
|
|
4101
|
+
declare class ValidationError {
|
|
4102
|
+
/**
|
|
4103
|
+
* The location as a [`Vec`] of [`String`]s -- often in the form `[\"body\", \"field_name\"]`, `[\"query\", \"field_name\"]`, etc. They may, however, be arbitrarily deep.
|
|
4104
|
+
*/
|
|
4105
|
+
loc: Array<string>;
|
|
4106
|
+
/**
|
|
4107
|
+
* The message accompanying the validation error item.
|
|
4108
|
+
*/
|
|
4109
|
+
msg: string;
|
|
4110
|
+
/**
|
|
4111
|
+
* The type of error, often \"type_error\" or \"value_error\", but sometimes with more context like as \"value_error.number.not_ge\"
|
|
4112
|
+
*/
|
|
4113
|
+
type: string;
|
|
4114
|
+
static readonly discriminator: string | undefined;
|
|
4115
|
+
static readonly mapping: {
|
|
4116
|
+
[index: string]: string;
|
|
4117
|
+
} | undefined;
|
|
4118
|
+
static readonly attributeTypeMap: Array<{
|
|
4119
|
+
name: string;
|
|
4120
|
+
baseName: string;
|
|
4121
|
+
type: string;
|
|
4122
|
+
format: string;
|
|
4123
|
+
}>;
|
|
4124
|
+
static getAttributeTypeMap(): {
|
|
4125
|
+
name: string;
|
|
4126
|
+
baseName: string;
|
|
4127
|
+
type: string;
|
|
4128
|
+
format: string;
|
|
4129
|
+
}[];
|
|
4130
|
+
}
|
|
4131
|
+
declare class HTTPValidationError {
|
|
4132
|
+
detail: Array<ValidationError>;
|
|
4133
|
+
static readonly discriminator: string | undefined;
|
|
4134
|
+
static readonly mapping: {
|
|
4135
|
+
[index: string]: string;
|
|
4136
|
+
} | undefined;
|
|
4137
|
+
static readonly attributeTypeMap: Array<{
|
|
4138
|
+
name: string;
|
|
4139
|
+
baseName: string;
|
|
4140
|
+
type: string;
|
|
4141
|
+
format: string;
|
|
4142
|
+
}>;
|
|
4143
|
+
static getAttributeTypeMap(): {
|
|
4144
|
+
name: string;
|
|
4145
|
+
baseName: string;
|
|
4146
|
+
type: string;
|
|
4147
|
+
format: string;
|
|
4148
|
+
}[];
|
|
4149
|
+
}
|
|
4150
|
+
//#endregion
|
|
4151
|
+
//#region src/webhook.d.ts
|
|
4152
|
+
interface WebhookRequiredHeaders {
|
|
4153
|
+
"svix-id": string;
|
|
4154
|
+
"svix-timestamp": string;
|
|
4155
|
+
"svix-signature": string;
|
|
4156
|
+
}
|
|
4157
|
+
interface WebhookUnbrandedRequiredHeaders {
|
|
4158
|
+
"webhook-id": string;
|
|
4159
|
+
"webhook-timestamp": string;
|
|
4160
|
+
"webhook-signature": string;
|
|
4161
|
+
}
|
|
4162
|
+
interface WebhookOptions {
|
|
4163
|
+
format?: "raw";
|
|
4164
|
+
}
|
|
4165
|
+
declare class Webhook {
|
|
4166
|
+
private readonly inner;
|
|
4167
|
+
constructor(secret: string | Uint8Array, options?: WebhookOptions);
|
|
4168
|
+
verify(payload: string | Buffer, headers_: WebhookRequiredHeaders | WebhookUnbrandedRequiredHeaders | Record<string, string>): unknown;
|
|
4169
|
+
sign(msgId: string, timestamp: Date, payload: string | Buffer): string;
|
|
4170
|
+
}
|
|
4171
|
+
//#endregion
|
|
4172
|
+
//#region src/autoconfig.d.ts
|
|
4173
|
+
declare class AutoConfigError extends Error {
|
|
4174
|
+
constructor(message?: string);
|
|
4175
|
+
}
|
|
4176
|
+
declare class AutoConfig {
|
|
4177
|
+
private readonly appId;
|
|
4178
|
+
private readonly endpointId;
|
|
4179
|
+
private readonly endpointIn;
|
|
4180
|
+
private readonly webhook;
|
|
4181
|
+
private readonly requestCtx;
|
|
4182
|
+
constructor(token: string, endpoint: EndpointIn);
|
|
4183
|
+
subscribe(): Promise<EndpointOut>;
|
|
4184
|
+
verify(payload: string | Buffer, headers: WebhookRequiredHeaders | WebhookUnbrandedRequiredHeaders | Record<string, string>): unknown;
|
|
4185
|
+
}
|
|
4186
|
+
//#endregion
|
|
4187
|
+
//#region src/models/pollerV2MessageOut.d.ts
|
|
4188
|
+
/** The MessageOut equivalent of polling endpoint */
|
|
4189
|
+
interface PollerV2MessageOut {
|
|
4190
|
+
offset: number;
|
|
4191
|
+
headers?: {
|
|
4192
|
+
[key: string]: string;
|
|
4193
|
+
} | null;
|
|
4194
|
+
/** Optional unique identifier for the message */
|
|
4195
|
+
eventId?: string | null;
|
|
4196
|
+
/** The event type's name */
|
|
4197
|
+
eventType: string;
|
|
4198
|
+
payload: any;
|
|
4199
|
+
/** List of free-form identifiers that endpoints can filter by */
|
|
4200
|
+
channels?: string[] | null;
|
|
4201
|
+
/** The Message's ID. */
|
|
4202
|
+
id: string;
|
|
4203
|
+
timestamp: Date;
|
|
4204
|
+
tags?: string[] | null;
|
|
4205
|
+
deliverAt?: Date | null;
|
|
4206
|
+
}
|
|
4207
|
+
//#endregion
|
|
4208
|
+
//#region src/models/pollerV2PollOut.d.ts
|
|
4209
|
+
interface PollerV2PollOut {
|
|
4210
|
+
data: PollerV2MessageOut[];
|
|
4211
|
+
done: boolean;
|
|
4212
|
+
}
|
|
4213
|
+
//#endregion
|
|
4214
|
+
//#region src/models/startingPosition.d.ts
|
|
4215
|
+
declare enum StartingPosition {
|
|
4216
|
+
Earliest = "earliest",
|
|
4217
|
+
Latest = "latest"
|
|
4218
|
+
}
|
|
4219
|
+
//#endregion
|
|
4220
|
+
//#region src/api_internal/messagePollerv2.d.ts
|
|
4221
|
+
interface MessagePollerv2ConsumerPollOptions {
|
|
4222
|
+
limit?: number;
|
|
4223
|
+
/** Lease duration in milliseconds. */
|
|
4224
|
+
leaseDurationMs?: number;
|
|
4225
|
+
startingPosition?: StartingPosition;
|
|
4226
|
+
}
|
|
4227
|
+
interface MessagePollerv2ConsumerCommitOptions {
|
|
4228
|
+
idempotencyKey?: string;
|
|
4229
|
+
}
|
|
4230
|
+
//#endregion
|
|
4231
|
+
//#region src/models/sinkInCommon.d.ts
|
|
4232
|
+
interface SinkInCommon {
|
|
4233
|
+
description?: string;
|
|
4234
|
+
/**
|
|
4235
|
+
* Maximum messages per second to send to this endpoint.
|
|
4236
|
+
*
|
|
4237
|
+
* Outgoing messages will be throttled to this rate.
|
|
4238
|
+
*/
|
|
4239
|
+
throttleRate?: number | null;
|
|
4240
|
+
/** Optional unique identifier for the sink. */
|
|
4241
|
+
uid?: string | null;
|
|
4242
|
+
/**
|
|
4243
|
+
* The endpoint's verification secret.
|
|
4244
|
+
*
|
|
4245
|
+
* Format: `base64` encoded random bytes optionally prefixed with `whsec_`.
|
|
4246
|
+
* It is recommended to not set this and let the server generate the secret.
|
|
4247
|
+
*/
|
|
4248
|
+
secret?: string | null;
|
|
4249
|
+
disabled?: boolean;
|
|
4250
|
+
eventTypes?: string[] | null;
|
|
4251
|
+
/** List of message channels this sink listens to (omit for all). */
|
|
4252
|
+
channels?: string[] | null;
|
|
4253
|
+
metadata?: {
|
|
4254
|
+
[key: string]: string;
|
|
4255
|
+
};
|
|
4256
|
+
}
|
|
4257
|
+
//#endregion
|
|
4258
|
+
//#region src/autoconfigConsumer.d.ts
|
|
4259
|
+
declare class AutoConfigConsumer {
|
|
4260
|
+
private readonly appId;
|
|
4261
|
+
private readonly sinkId;
|
|
4262
|
+
private readonly sinkIn;
|
|
4263
|
+
private readonly requestCtx;
|
|
4264
|
+
constructor(token: string, sinkIn: SinkInCommon);
|
|
4265
|
+
subscribe(): Promise<EndpointOut>;
|
|
4266
|
+
receive(consumerId: string, options?: MessagePollerv2ConsumerPollOptions): Promise<PollerV2PollOut>;
|
|
4267
|
+
commit(consumerId: string, offset: number, options?: MessagePollerv2ConsumerCommitOptions): Promise<void>;
|
|
4268
|
+
}
|
|
4269
|
+
//#endregion
|
|
4270
|
+
//#region src/index.d.ts
|
|
4271
|
+
type SvixOptions = {
|
|
4272
|
+
debug?: boolean;
|
|
4273
|
+
serverUrl?: string;
|
|
4274
|
+
/** Time in milliseconds to wait for requests to get a response. */
|
|
4275
|
+
requestTimeout?: number;
|
|
4276
|
+
/**
|
|
4277
|
+
* Custom fetch implementation to use for HTTP requests.
|
|
4278
|
+
* Useful for testing, adding custom middleware, or running in non-standard environments.
|
|
4279
|
+
*/
|
|
4280
|
+
fetch?: typeof fetch;
|
|
4281
|
+
} & XOR<{
|
|
4282
|
+
/** List of delays (in milliseconds) to wait before each retry attempt.*/
|
|
4283
|
+
retryScheduleInMs?: number[];
|
|
4284
|
+
}, {
|
|
4285
|
+
/** The number of times the client will retry if a server-side error
|
|
4286
|
+
* or timeout is received.
|
|
4287
|
+
* Default: 2
|
|
4288
|
+
*/
|
|
4289
|
+
numRetries?: number;
|
|
4290
|
+
}>;
|
|
4291
|
+
declare class Svix {
|
|
4292
|
+
protected readonly requestCtx: SvixRequestContext;
|
|
4293
|
+
constructor(token: string, options?: SvixOptions);
|
|
4294
|
+
get application(): Application;
|
|
4295
|
+
get authentication(): Authentication;
|
|
4296
|
+
get backgroundTask(): BackgroundTask;
|
|
4297
|
+
get connector(): Connector;
|
|
4298
|
+
get endpoint(): Endpoint;
|
|
4299
|
+
get environment(): Environment;
|
|
4300
|
+
get eventType(): EventType;
|
|
4301
|
+
get health(): Health;
|
|
4302
|
+
get ingest(): Ingest;
|
|
4303
|
+
get integration(): Integration;
|
|
4304
|
+
get message(): Message;
|
|
4305
|
+
get messageAttempt(): MessageAttempt;
|
|
4306
|
+
get operationalWebhook(): OperationalWebhook;
|
|
4307
|
+
get statistics(): Statistics;
|
|
4308
|
+
get streaming(): Streaming;
|
|
4309
|
+
}
|
|
4310
|
+
//#endregion
|
|
4311
|
+
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 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 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 };
|
|
4312
|
+
//# sourceMappingURL=index.d.mts.map
|