svix 1.99.0 → 2.0.0-rc.2

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