@epilot/sdk 2.4.2 → 2.4.4-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (364) hide show
  1. package/README.md +1 -0
  2. package/definitions/app-runtime.json +1 -1
  3. package/definitions/app.json +346 -10
  4. package/definitions/automation.json +42 -0
  5. package/definitions/calendar-runtime.json +1 -0
  6. package/definitions/calendar.json +675 -0
  7. package/definitions/customer-portal.json +29 -0
  8. package/definitions/notes.json +175 -130
  9. package/definitions/pricing-runtime.json +1 -1
  10. package/definitions/pricing.json +163 -84
  11. package/dist/README-46VYEGGW.js +7 -0
  12. package/dist/README-IVBISSWB.cjs +7 -0
  13. package/dist/{_index-HE4B6FOA.js → _index-5FB6F5YY.js} +3 -0
  14. package/dist/{_index-55HAH24D.cjs → _index-DB2VV4PQ.cjs} +4 -1
  15. package/dist/apis/_registry.d.ts +8 -0
  16. package/dist/apis/access-token.cjs +6 -6
  17. package/dist/apis/access-token.d.ts +9 -12
  18. package/dist/apis/access-token.js +1 -1
  19. package/dist/apis/address-suggestions.cjs +6 -6
  20. package/dist/apis/address-suggestions.d.ts +9 -12
  21. package/dist/apis/address-suggestions.js +1 -1
  22. package/dist/apis/address.cjs +6 -6
  23. package/dist/apis/address.d.ts +9 -12
  24. package/dist/apis/address.js +1 -1
  25. package/dist/apis/ai-agents.cjs +6 -6
  26. package/dist/apis/ai-agents.d.ts +9 -12
  27. package/dist/apis/ai-agents.js +1 -1
  28. package/dist/apis/app.cjs +6 -6
  29. package/dist/apis/app.d.ts +9 -12
  30. package/dist/apis/app.js +1 -1
  31. package/dist/apis/audit-logs.cjs +6 -6
  32. package/dist/apis/audit-logs.d.ts +9 -12
  33. package/dist/apis/audit-logs.js +1 -1
  34. package/dist/apis/automation.cjs +6 -6
  35. package/dist/apis/automation.d.ts +9 -12
  36. package/dist/apis/automation.js +1 -1
  37. package/dist/apis/billing.cjs +6 -6
  38. package/dist/apis/billing.d.ts +9 -12
  39. package/dist/apis/billing.js +1 -1
  40. package/dist/apis/blueprint-manifest.cjs +6 -6
  41. package/dist/apis/blueprint-manifest.d.ts +9 -12
  42. package/dist/apis/blueprint-manifest.js +1 -1
  43. package/dist/apis/calendar.cjs +38 -0
  44. package/dist/apis/calendar.d.ts +15 -0
  45. package/dist/apis/calendar.js +38 -0
  46. package/dist/apis/configuration-hub.cjs +6 -6
  47. package/dist/apis/configuration-hub.d.ts +9 -12
  48. package/dist/apis/configuration-hub.js +1 -1
  49. package/dist/apis/consent.cjs +6 -6
  50. package/dist/apis/consent.d.ts +9 -12
  51. package/dist/apis/consent.js +1 -1
  52. package/dist/apis/customer-portal.cjs +6 -6
  53. package/dist/apis/customer-portal.d.ts +9 -12
  54. package/dist/apis/customer-portal.js +1 -1
  55. package/dist/apis/dashboard.cjs +6 -6
  56. package/dist/apis/dashboard.d.ts +9 -12
  57. package/dist/apis/dashboard.js +1 -1
  58. package/dist/apis/data-governance.cjs +6 -6
  59. package/dist/apis/data-governance.d.ts +9 -12
  60. package/dist/apis/data-governance.js +1 -1
  61. package/dist/apis/deduplication.cjs +6 -6
  62. package/dist/apis/deduplication.d.ts +9 -12
  63. package/dist/apis/deduplication.js +1 -1
  64. package/dist/apis/design.cjs +6 -6
  65. package/dist/apis/design.d.ts +9 -12
  66. package/dist/apis/design.js +1 -1
  67. package/dist/apis/document.cjs +6 -6
  68. package/dist/apis/document.d.ts +9 -12
  69. package/dist/apis/document.js +1 -1
  70. package/dist/apis/email-settings.cjs +6 -6
  71. package/dist/apis/email-settings.d.ts +9 -12
  72. package/dist/apis/email-settings.js +1 -1
  73. package/dist/apis/email-template.cjs +6 -6
  74. package/dist/apis/email-template.d.ts +9 -12
  75. package/dist/apis/email-template.js +1 -1
  76. package/dist/apis/entity-mapping.cjs +6 -6
  77. package/dist/apis/entity-mapping.d.ts +9 -12
  78. package/dist/apis/entity-mapping.js +1 -1
  79. package/dist/apis/entity.cjs +6 -6
  80. package/dist/apis/entity.d.ts +9 -12
  81. package/dist/apis/entity.js +1 -1
  82. package/dist/apis/environments.cjs +6 -6
  83. package/dist/apis/environments.d.ts +9 -12
  84. package/dist/apis/environments.js +1 -1
  85. package/dist/apis/event-catalog.cjs +6 -6
  86. package/dist/apis/event-catalog.d.ts +9 -12
  87. package/dist/apis/event-catalog.js +1 -1
  88. package/dist/apis/file.cjs +6 -6
  89. package/dist/apis/file.d.ts +9 -12
  90. package/dist/apis/file.js +1 -1
  91. package/dist/apis/iban.cjs +6 -6
  92. package/dist/apis/iban.d.ts +9 -12
  93. package/dist/apis/iban.js +1 -1
  94. package/dist/apis/integration-toolkit.cjs +6 -6
  95. package/dist/apis/integration-toolkit.d.ts +9 -12
  96. package/dist/apis/integration-toolkit.js +1 -1
  97. package/dist/apis/journey.cjs +6 -6
  98. package/dist/apis/journey.d.ts +9 -12
  99. package/dist/apis/journey.js +1 -1
  100. package/dist/apis/kanban.cjs +6 -6
  101. package/dist/apis/kanban.d.ts +9 -12
  102. package/dist/apis/kanban.js +1 -1
  103. package/dist/apis/message.cjs +6 -6
  104. package/dist/apis/message.d.ts +9 -12
  105. package/dist/apis/message.js +1 -1
  106. package/dist/apis/metering.cjs +6 -6
  107. package/dist/apis/metering.d.ts +9 -12
  108. package/dist/apis/metering.js +1 -1
  109. package/dist/apis/notes.cjs +6 -6
  110. package/dist/apis/notes.d.ts +9 -12
  111. package/dist/apis/notes.js +1 -1
  112. package/dist/apis/notification.cjs +6 -6
  113. package/dist/apis/notification.d.ts +9 -12
  114. package/dist/apis/notification.js +1 -1
  115. package/dist/apis/organization.cjs +6 -6
  116. package/dist/apis/organization.d.ts +9 -12
  117. package/dist/apis/organization.js +1 -1
  118. package/dist/apis/partner-directory.cjs +6 -6
  119. package/dist/apis/partner-directory.d.ts +9 -12
  120. package/dist/apis/partner-directory.js +1 -1
  121. package/dist/apis/permissions.cjs +6 -6
  122. package/dist/apis/permissions.d.ts +9 -12
  123. package/dist/apis/permissions.js +1 -1
  124. package/dist/apis/pricing-tier.cjs +6 -6
  125. package/dist/apis/pricing-tier.d.ts +9 -12
  126. package/dist/apis/pricing-tier.js +1 -1
  127. package/dist/apis/pricing.cjs +8 -8
  128. package/dist/apis/pricing.d.ts +9 -12
  129. package/dist/apis/pricing.js +2 -2
  130. package/dist/apis/purpose.cjs +6 -6
  131. package/dist/apis/purpose.d.ts +9 -12
  132. package/dist/apis/purpose.js +1 -1
  133. package/dist/apis/query.cjs +6 -6
  134. package/dist/apis/query.d.ts +9 -12
  135. package/dist/apis/query.js +1 -1
  136. package/dist/apis/sandbox.cjs +6 -6
  137. package/dist/apis/sandbox.d.ts +9 -12
  138. package/dist/apis/sandbox.js +1 -1
  139. package/dist/apis/sharing.cjs +6 -6
  140. package/dist/apis/sharing.d.ts +9 -12
  141. package/dist/apis/sharing.js +1 -1
  142. package/dist/apis/submission.cjs +6 -6
  143. package/dist/apis/submission.d.ts +9 -12
  144. package/dist/apis/submission.js +1 -1
  145. package/dist/apis/target.cjs +6 -6
  146. package/dist/apis/target.d.ts +9 -591
  147. package/dist/apis/target.js +1 -1
  148. package/dist/apis/targeting.cjs +6 -6
  149. package/dist/apis/targeting.d.ts +9 -12
  150. package/dist/apis/targeting.js +1 -1
  151. package/dist/apis/template-variables.cjs +6 -6
  152. package/dist/apis/template-variables.d.ts +9 -12
  153. package/dist/apis/template-variables.js +1 -1
  154. package/dist/apis/user.cjs +6 -6
  155. package/dist/apis/user.d.ts +9 -12
  156. package/dist/apis/user.js +1 -1
  157. package/dist/apis/validation-rules.cjs +6 -6
  158. package/dist/apis/validation-rules.d.ts +9 -12
  159. package/dist/apis/validation-rules.js +1 -1
  160. package/dist/apis/webhooks.cjs +6 -6
  161. package/dist/apis/webhooks.d.ts +9 -12
  162. package/dist/apis/webhooks.js +1 -1
  163. package/dist/apis/workflow-definition.cjs +6 -6
  164. package/dist/apis/workflow-definition.d.ts +9 -12
  165. package/dist/apis/workflow-definition.js +1 -1
  166. package/dist/apis/workflow.cjs +6 -6
  167. package/dist/apis/workflow.d.ts +9 -12
  168. package/dist/apis/workflow.js +1 -1
  169. package/dist/authorize.d.ts +3 -0
  170. package/dist/automation-BMO7ZFTN.cjs +7 -0
  171. package/dist/automation-MEZTSUR3.js +7 -0
  172. package/dist/bin/cli.d.ts +1 -0
  173. package/dist/bin/cli.js +1 -1
  174. package/dist/calendar-2YDAYG7S.cjs +7 -0
  175. package/dist/calendar-ACFIHQ2N.js +7 -0
  176. package/dist/calendar-runtime-6CMMEQMG.js +5 -0
  177. package/dist/calendar-runtime-G4SN5PDY.cjs +5 -0
  178. package/dist/{chunk-MEUS7LCE.js → chunk-63BFJKWV.js} +1 -1
  179. package/dist/{chunk-YLJD7G7H.cjs → chunk-CD4OX2U6.cjs} +7 -5
  180. package/dist/chunk-CKLEBO4K.cjs +14 -0
  181. package/dist/chunk-JNH37UUH.js +14 -0
  182. package/dist/{chunk-JXJC6WEW.cjs → chunk-KP7H52BF.cjs} +1 -1
  183. package/dist/{chunk-CQ3AKMIJ.js → chunk-TSV242UN.js} +7 -5
  184. package/dist/client-factory.d.ts +9 -0
  185. package/dist/client-map.d.ts +102 -0
  186. package/dist/compact.d.ts +22 -0
  187. package/dist/help.d.ts +12 -0
  188. package/dist/index.cjs +27 -19
  189. package/dist/index.d.ts +12 -180
  190. package/dist/index.js +22 -14
  191. package/dist/{js-yaml-DLCVPJ7G.js → js-yaml-UPZKYVRY.js} +15 -17
  192. package/dist/large-response.d.ts +9 -0
  193. package/dist/openapi.d.ts +12 -0
  194. package/dist/overrides.d.ts +9 -0
  195. package/dist/pricing-G67CH3XH.js +7 -0
  196. package/dist/pricing-XAET4G7T.cjs +7 -0
  197. package/dist/{pricing-runtime-JRR4FWFI.js → pricing-runtime-2YKEJJMZ.js} +1 -1
  198. package/dist/{pricing-runtime-6XNS4EOF.cjs → pricing-runtime-XDCOKL47.cjs} +2 -2
  199. package/dist/proxy.d.ts +14 -0
  200. package/dist/registry.d.ts +19 -0
  201. package/dist/retry.d.ts +11 -0
  202. package/dist/sdk.d.ts +29 -0
  203. package/dist/types.d.ts +53 -0
  204. package/docs/automation.md +42 -5
  205. package/docs/calendar.md +441 -0
  206. package/docs/pricing.md +39 -15
  207. package/package.json +10 -1
  208. package/dist/README-6MG272KM.cjs +0 -7
  209. package/dist/README-7N542PBL.js +0 -7
  210. package/dist/access-token.d-CnmUTOlq.d.cts +0 -552
  211. package/dist/access-token.d-CnmUTOlq.d.ts +0 -552
  212. package/dist/address-suggestions.d-_YwTOR-9.d.cts +0 -339
  213. package/dist/address-suggestions.d-_YwTOR-9.d.ts +0 -339
  214. package/dist/address.d-CwAPOVxa.d.cts +0 -437
  215. package/dist/address.d-CwAPOVxa.d.ts +0 -437
  216. package/dist/ai-agents.d-OkXfr2bz.d.cts +0 -1339
  217. package/dist/ai-agents.d-OkXfr2bz.d.ts +0 -1339
  218. package/dist/apis/access-token.d.cts +0 -18
  219. package/dist/apis/address-suggestions.d.cts +0 -18
  220. package/dist/apis/address.d.cts +0 -18
  221. package/dist/apis/ai-agents.d.cts +0 -18
  222. package/dist/apis/app.d.cts +0 -18
  223. package/dist/apis/audit-logs.d.cts +0 -18
  224. package/dist/apis/automation.d.cts +0 -18
  225. package/dist/apis/billing.d.cts +0 -18
  226. package/dist/apis/blueprint-manifest.d.cts +0 -18
  227. package/dist/apis/configuration-hub.d.cts +0 -18
  228. package/dist/apis/consent.d.cts +0 -18
  229. package/dist/apis/customer-portal.d.cts +0 -18
  230. package/dist/apis/dashboard.d.cts +0 -18
  231. package/dist/apis/data-governance.d.cts +0 -18
  232. package/dist/apis/deduplication.d.cts +0 -18
  233. package/dist/apis/design.d.cts +0 -18
  234. package/dist/apis/document.d.cts +0 -18
  235. package/dist/apis/email-settings.d.cts +0 -18
  236. package/dist/apis/email-template.d.cts +0 -18
  237. package/dist/apis/entity-mapping.d.cts +0 -18
  238. package/dist/apis/entity.d.cts +0 -18
  239. package/dist/apis/environments.d.cts +0 -18
  240. package/dist/apis/event-catalog.d.cts +0 -18
  241. package/dist/apis/file.d.cts +0 -18
  242. package/dist/apis/iban.d.cts +0 -18
  243. package/dist/apis/integration-toolkit.d.cts +0 -18
  244. package/dist/apis/journey.d.cts +0 -18
  245. package/dist/apis/kanban.d.cts +0 -18
  246. package/dist/apis/message.d.cts +0 -18
  247. package/dist/apis/metering.d.cts +0 -18
  248. package/dist/apis/notes.d.cts +0 -18
  249. package/dist/apis/notification.d.cts +0 -18
  250. package/dist/apis/organization.d.cts +0 -18
  251. package/dist/apis/partner-directory.d.cts +0 -18
  252. package/dist/apis/permissions.d.cts +0 -18
  253. package/dist/apis/pricing-tier.d.cts +0 -18
  254. package/dist/apis/pricing.d.cts +0 -18
  255. package/dist/apis/purpose.d.cts +0 -18
  256. package/dist/apis/query.d.cts +0 -18
  257. package/dist/apis/sandbox.d.cts +0 -18
  258. package/dist/apis/sharing.d.cts +0 -18
  259. package/dist/apis/submission.d.cts +0 -18
  260. package/dist/apis/target.d.cts +0 -597
  261. package/dist/apis/targeting.d.cts +0 -18
  262. package/dist/apis/template-variables.d.cts +0 -18
  263. package/dist/apis/user.d.cts +0 -18
  264. package/dist/apis/validation-rules.d.cts +0 -18
  265. package/dist/apis/webhooks.d.cts +0 -18
  266. package/dist/apis/workflow-definition.d.cts +0 -18
  267. package/dist/apis/workflow.d.cts +0 -18
  268. package/dist/app.d-u7Dq42kU.d.cts +0 -3391
  269. package/dist/app.d-u7Dq42kU.d.ts +0 -3391
  270. package/dist/audit-logs.d-BRToFqeX.d.cts +0 -287
  271. package/dist/audit-logs.d-BRToFqeX.d.ts +0 -287
  272. package/dist/automation-GFNNLSIN.js +0 -7
  273. package/dist/automation-IOCVCTKR.cjs +0 -7
  274. package/dist/automation.d-CzhG2m4L.d.cts +0 -5252
  275. package/dist/automation.d-CzhG2m4L.d.ts +0 -5252
  276. package/dist/billing.d-Bs8Ku9qE.d.cts +0 -993
  277. package/dist/billing.d-Bs8Ku9qE.d.ts +0 -993
  278. package/dist/blueprint-manifest.d-BPyzoR0X.d.cts +0 -4343
  279. package/dist/blueprint-manifest.d-BPyzoR0X.d.ts +0 -4343
  280. package/dist/configuration-hub.d-Cqaq2F-W.d.cts +0 -478
  281. package/dist/configuration-hub.d-Cqaq2F-W.d.ts +0 -478
  282. package/dist/consent.d-C2PROHhX.d.cts +0 -265
  283. package/dist/consent.d-C2PROHhX.d.ts +0 -265
  284. package/dist/customer-portal.d-DyZ2n2dW.d.cts +0 -16728
  285. package/dist/customer-portal.d-DyZ2n2dW.d.ts +0 -16728
  286. package/dist/dashboard.d-CsGcA74I.d.cts +0 -440
  287. package/dist/dashboard.d-CsGcA74I.d.ts +0 -440
  288. package/dist/data-governance.d-BbZ466j5.d.cts +0 -1178
  289. package/dist/data-governance.d-BbZ466j5.d.ts +0 -1178
  290. package/dist/deduplication.d-D5GYddVu.d.cts +0 -218
  291. package/dist/deduplication.d-D5GYddVu.d.ts +0 -218
  292. package/dist/design.d-BRre8iLg.d.cts +0 -2346
  293. package/dist/design.d-BRre8iLg.d.ts +0 -2346
  294. package/dist/document.d-DN37pjdx.d.cts +0 -648
  295. package/dist/document.d-DN37pjdx.d.ts +0 -648
  296. package/dist/email-settings.d-B7Q_xT25.d.cts +0 -2417
  297. package/dist/email-settings.d-B7Q_xT25.d.ts +0 -2417
  298. package/dist/email-template.d-gtQkdaXM.d.cts +0 -1188
  299. package/dist/email-template.d-gtQkdaXM.d.ts +0 -1188
  300. package/dist/entity-mapping.d-DKSW3sfy.d.cts +0 -1092
  301. package/dist/entity-mapping.d-DKSW3sfy.d.ts +0 -1092
  302. package/dist/entity.d-BHR9dEon.d.cts +0 -18479
  303. package/dist/entity.d-BHR9dEon.d.ts +0 -18479
  304. package/dist/environments.d-BvqvN-PD.d.cts +0 -382
  305. package/dist/environments.d-BvqvN-PD.d.ts +0 -382
  306. package/dist/event-catalog.d-ENw6HO-w.d.cts +0 -1511
  307. package/dist/event-catalog.d-ENw6HO-w.d.ts +0 -1511
  308. package/dist/file.d-DcTJxjp7.d.cts +0 -2992
  309. package/dist/file.d-DcTJxjp7.d.ts +0 -2992
  310. package/dist/iban.d-BwdiGbxi.d.cts +0 -70
  311. package/dist/iban.d-BwdiGbxi.d.ts +0 -70
  312. package/dist/index.d.cts +0 -180
  313. package/dist/integration-toolkit.d-Ry-KC9ow.d.cts +0 -5796
  314. package/dist/integration-toolkit.d-Ry-KC9ow.d.ts +0 -5796
  315. package/dist/journey.d-ClXO0xK8.d.cts +0 -1931
  316. package/dist/journey.d-ClXO0xK8.d.ts +0 -1931
  317. package/dist/kanban.d-BHnSRCYW.d.cts +0 -760
  318. package/dist/kanban.d-BHnSRCYW.d.ts +0 -760
  319. package/dist/message.d-B5UuSqgw.d.cts +0 -3811
  320. package/dist/message.d-B5UuSqgw.d.ts +0 -3811
  321. package/dist/metering.d-DvtPv7wk.d.cts +0 -1841
  322. package/dist/metering.d-DvtPv7wk.d.ts +0 -1841
  323. package/dist/notes.d-BC-scR42.d.cts +0 -1046
  324. package/dist/notes.d-BC-scR42.d.ts +0 -1046
  325. package/dist/notification.d-BfBL3lga.d.cts +0 -1147
  326. package/dist/notification.d-BfBL3lga.d.ts +0 -1147
  327. package/dist/organization.d-DqwnNxMg.d.cts +0 -1271
  328. package/dist/organization.d-DqwnNxMg.d.ts +0 -1271
  329. package/dist/partner-directory.d-BCIjHoGs.d.cts +0 -2337
  330. package/dist/partner-directory.d-BCIjHoGs.d.ts +0 -2337
  331. package/dist/permissions.d-l6AT8SYP.d.cts +0 -1279
  332. package/dist/permissions.d-l6AT8SYP.d.ts +0 -1279
  333. package/dist/pricing-4Z4TOETA.cjs +0 -7
  334. package/dist/pricing-C65DTZSX.js +0 -7
  335. package/dist/pricing-tier.d-Cg0jl6n_.d.cts +0 -81
  336. package/dist/pricing-tier.d-Cg0jl6n_.d.ts +0 -81
  337. package/dist/pricing.d-Cv39plGm.d.cts +0 -12200
  338. package/dist/pricing.d-Cv39plGm.d.ts +0 -12200
  339. package/dist/purpose.d-CbIYfTua.d.cts +0 -372
  340. package/dist/purpose.d-CbIYfTua.d.ts +0 -372
  341. package/dist/query.d-Cmp78IhZ.d.cts +0 -2375
  342. package/dist/query.d-Cmp78IhZ.d.ts +0 -2375
  343. package/dist/sandbox.d-BdbOFzDu.d.cts +0 -465
  344. package/dist/sandbox.d-BdbOFzDu.d.ts +0 -465
  345. package/dist/sharing.d-sOXq-gtz.d.cts +0 -571
  346. package/dist/sharing.d-sOXq-gtz.d.ts +0 -571
  347. package/dist/submission.d-BamwfhXw.d.cts +0 -469
  348. package/dist/submission.d-BamwfhXw.d.ts +0 -469
  349. package/dist/targeting.d-BNmcVsNS.d.cts +0 -2057
  350. package/dist/targeting.d-BNmcVsNS.d.ts +0 -2057
  351. package/dist/template-variables.d-Ble9TSBa.d.cts +0 -1320
  352. package/dist/template-variables.d-Ble9TSBa.d.ts +0 -1320
  353. package/dist/types-ChU9Acbv.d.cts +0 -37
  354. package/dist/types-ChU9Acbv.d.ts +0 -37
  355. package/dist/user.d-D18fe97W.d.cts +0 -2270
  356. package/dist/user.d-D18fe97W.d.ts +0 -2270
  357. package/dist/validation-rules.d-Db5c5zTf.d.cts +0 -807
  358. package/dist/validation-rules.d-Db5c5zTf.d.ts +0 -807
  359. package/dist/webhooks.d-pLHIL_io.d.cts +0 -1256
  360. package/dist/webhooks.d-pLHIL_io.d.ts +0 -1256
  361. package/dist/workflow-definition.d-DOeb0KVV.d.cts +0 -1922
  362. package/dist/workflow-definition.d-DOeb0KVV.d.ts +0 -1922
  363. package/dist/workflow.d-CMSKt8oN.d.cts +0 -3151
  364. package/dist/workflow.d-CMSKt8oN.d.ts +0 -3151
@@ -1,1256 +0,0 @@
1
- import { OpenAPIClient, Parameters, AxiosRequestConfig, OperationResponse, UnknownParamsObject } from 'openapi-client-axios';
2
-
3
- /* Auto-copied from webhooks-client */
4
-
5
-
6
- declare namespace Components {
7
- namespace Schemas {
8
- /**
9
- * To be sent only if authType is API_KEY
10
- */
11
- export interface ApiKeyConfig {
12
- keyName: string;
13
- keyValue?: string;
14
- /**
15
- * When true, indicates the keyValue is an environment variable reference (e.g. {{ env.my_secret }})
16
- */
17
- keyValueIsEnvVar?: boolean;
18
- }
19
- export interface Auth {
20
- authType: AuthType;
21
- basicAuthConfig?: /* To be sent only if authType is BASIC */ BasicAuthConfig;
22
- oauthConfig?: /* To be sent only if authType is OAUTH_CLIENT_CREDENTIALS */ OAuthConfig;
23
- apiKeyConfig?: /* To be sent only if authType is API_KEY */ ApiKeyConfig;
24
- }
25
- export type AuthType = "BASIC" | "OAUTH_CLIENT_CREDENTIALS" | "API_KEY" | "NONE";
26
- /**
27
- * To be sent only if authType is BASIC
28
- */
29
- export interface BasicAuthConfig {
30
- username: string;
31
- password?: string;
32
- /**
33
- * When true, indicates the password value is an environment variable reference (e.g. {{ env.my_secret }})
34
- */
35
- passwordIsEnvVar?: boolean;
36
- }
37
- export interface BatchReplayRequest {
38
- /**
39
- * List of event IDs to replay
40
- * example:
41
- * [
42
- * "2f1b7cf8-ff55-4359-966f-e56f39a52c94",
43
- * "48c984bf-466b-470b-b743-d07cea168243"
44
- * ]
45
- */
46
- eventIds: [
47
- string,
48
- string?,
49
- string?,
50
- string?,
51
- string?,
52
- string?,
53
- string?,
54
- string?,
55
- string?,
56
- string?,
57
- string?,
58
- string?,
59
- string?,
60
- string?,
61
- string?,
62
- string?,
63
- string?,
64
- string?,
65
- string?,
66
- string?,
67
- string?,
68
- string?,
69
- string?,
70
- string?,
71
- string?,
72
- string?,
73
- string?,
74
- string?,
75
- string?,
76
- string?,
77
- string?,
78
- string?,
79
- string?,
80
- string?,
81
- string?,
82
- string?,
83
- string?,
84
- string?,
85
- string?,
86
- string?,
87
- string?,
88
- string?,
89
- string?,
90
- string?,
91
- string?,
92
- string?,
93
- string?,
94
- string?,
95
- string?,
96
- string?,
97
- string?,
98
- string?,
99
- string?,
100
- string?,
101
- string?,
102
- string?,
103
- string?,
104
- string?,
105
- string?,
106
- string?,
107
- string?,
108
- string?,
109
- string?,
110
- string?,
111
- string?,
112
- string?,
113
- string?,
114
- string?,
115
- string?,
116
- string?,
117
- string?,
118
- string?,
119
- string?,
120
- string?,
121
- string?,
122
- string?,
123
- string?,
124
- string?,
125
- string?,
126
- string?,
127
- string?,
128
- string?,
129
- string?,
130
- string?,
131
- string?,
132
- string?,
133
- string?,
134
- string?,
135
- string?,
136
- string?,
137
- string?,
138
- string?,
139
- string?,
140
- string?,
141
- string?,
142
- string?,
143
- string?,
144
- string?,
145
- string?,
146
- string?
147
- ];
148
- }
149
- /**
150
- * Object representing custom headers as key-value pairs.
151
- */
152
- export interface CustomHeader {
153
- [name: string]: string;
154
- }
155
- /**
156
- * Custom key/value pair of either type body, query or header
157
- */
158
- export interface CustomOAuthParameter {
159
- type: "body" | "query" | "header";
160
- key: string;
161
- value: string;
162
- }
163
- export interface ErrorResp {
164
- message?: string;
165
- }
166
- export interface EventConfigEntry {
167
- /**
168
- * Name for identifying the event. Unique.
169
- */
170
- eventName?: string;
171
- /**
172
- * Either a user friendly label, or the eventName itself.
173
- */
174
- eventLabel?: string;
175
- }
176
- /**
177
- * example:
178
- * [
179
- * {
180
- * "eventName": "customer_request_created",
181
- * "eventLabel": "Customer Request Created"
182
- * }
183
- * ]
184
- */
185
- export type EventConfigResp = EventConfigEntry[];
186
- export interface EventListResponse {
187
- /**
188
- * List of webhook events
189
- */
190
- data?: WebhookEvent[];
191
- /**
192
- * Cursor to fetch the next page. Null if no more results.
193
- */
194
- next_cursor?: {
195
- /**
196
- * example:
197
- * 2025-10-31T12:34:56Z
198
- */
199
- created_at?: string; // date-time
200
- /**
201
- * example:
202
- * evt_1234567890abcdef
203
- */
204
- event_id?: string;
205
- } | null;
206
- /**
207
- * Indicates if more results are available
208
- * example:
209
- * true
210
- */
211
- has_more?: boolean;
212
- }
213
- export interface ExampleRequest {
214
- /**
215
- * ID of the automation, if applicable
216
- * example:
217
- * automation_123
218
- */
219
- automation_id?: string;
220
- }
221
- export interface ExampleResponse {
222
- [name: string]: any;
223
- metadata?: /* Contains the metadata about the configured event */ Metadata;
224
- /**
225
- * Example payload for the webhook event
226
- */
227
- entity?: {
228
- [name: string]: any;
229
- };
230
- /**
231
- * Example relations for the webhook event
232
- */
233
- relations?: {
234
- [name: string]: any;
235
- }[];
236
- }
237
- /**
238
- * Payload for triggering a webhook
239
- */
240
- export interface ExecutionPayload {
241
- [name: string]: any;
242
- metadata: /* Contains the metadata about the configured event */ Metadata;
243
- }
244
- export interface Filter {
245
- keyToFilter: string;
246
- supportedValues: string[];
247
- }
248
- export type HttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD";
249
- /**
250
- * Contains the metadata about the configured event
251
- */
252
- export interface Metadata {
253
- /**
254
- * Action that triggered the event
255
- * example:
256
- * Manual triggered by user with id 123456
257
- */
258
- action?: string;
259
- /**
260
- * Origin of the event
261
- */
262
- origin?: string;
263
- /**
264
- * Time of event creation
265
- */
266
- creation_timestamp?: string;
267
- /**
268
- * The ID of the webhook configuration
269
- */
270
- webhook_id?: string;
271
- /**
272
- * The name of the webhook configuration
273
- */
274
- webhook_name?: string;
275
- /**
276
- * The name of the automation that triggered the event
277
- */
278
- automation_name?: string;
279
- /**
280
- * The ID of the given organization
281
- */
282
- organization_id: string;
283
- /**
284
- * The ID of the user for manual triggered events
285
- */
286
- user_id?: string;
287
- /**
288
- * ID used to track the event
289
- */
290
- correlation_id?: string;
291
- /**
292
- * When triggered by an automation this is its execution id
293
- */
294
- execution_id?: string;
295
- /**
296
- * When triggered by an automation this is the id of the action
297
- */
298
- action_id?: string;
299
- }
300
- /**
301
- * To be sent only if authType is OAUTH_CLIENT_CREDENTIALS
302
- */
303
- export interface OAuthConfig {
304
- clientId: string;
305
- clientSecret?: string;
306
- /**
307
- * When true, indicates the clientSecret value is an environment variable reference (e.g. {{ env.my_secret }})
308
- */
309
- clientSecretIsEnvVar?: boolean;
310
- /**
311
- * Https Endpoint for authentication
312
- */
313
- endpoint: string;
314
- httpMethod: HttpMethod;
315
- customParameterList?: /* Custom key/value pair of either type body, query or header */ CustomOAuthParameter[];
316
- }
317
- /**
318
- * Configuration for the webhook payload
319
- */
320
- export interface PayloadConfiguration {
321
- hydrate_entity?: boolean;
322
- include_relations?: boolean;
323
- include_activity?: boolean;
324
- include_changed_attributes?: boolean;
325
- custom_headers?: /* Object representing custom headers as key-value pairs. */ CustomHeader;
326
- }
327
- export interface PublicKeyResponse {
328
- /**
329
- * PEM-encoded Ed25519 public key for verifying webhook signatures
330
- * example:
331
- * -----BEGIN PUBLIC KEY-----
332
- * MCowBQYDK2VwAyEA...
333
- * -----END PUBLIC KEY-----
334
- *
335
- */
336
- public_key: string;
337
- /**
338
- * The signing algorithm used
339
- * example:
340
- * ed25519
341
- */
342
- algorithm: string;
343
- /**
344
- * The issuer of the signing key
345
- * example:
346
- * epilot
347
- */
348
- issuer?: string;
349
- }
350
- export interface SearchOptions {
351
- /**
352
- * Maximum number of results to return
353
- * example:
354
- * 25
355
- */
356
- limit?: number;
357
- /**
358
- * Cursor for pagination. Use the next_cursor from the previous response to get the next page.
359
- */
360
- cursor?: {
361
- /**
362
- * Timestamp from the last event in the previous page
363
- * example:
364
- * 2025-10-31T12:34:56Z
365
- */
366
- created_at?: string; // date-time
367
- /**
368
- * Event ID from the last event in the previous page
369
- * example:
370
- * evt_1234567890abcdef
371
- */
372
- event_id?: string;
373
- };
374
- /**
375
- * Filter events by timestamp range
376
- */
377
- timestamp?: {
378
- /**
379
- * Start timestamp in ISO 8601 format
380
- * example:
381
- * 2025-10-01T00:00:00Z
382
- */
383
- from?: string; // date-time
384
- /**
385
- * End timestamp in ISO 8601 format
386
- * example:
387
- * 2025-10-31T23:59:59Z
388
- */
389
- to?: string; // date-time
390
- };
391
- /**
392
- * Filter by specific event ID
393
- * example:
394
- * evt_1234567890abcdef
395
- */
396
- event_id?: string;
397
- /**
398
- * Filter by event outcome
399
- * example:
400
- * succeeded
401
- */
402
- status?: "succeeded" | "failed" | "skipped";
403
- }
404
- export interface TriggerWebhookResp {
405
- status_code?: string;
406
- message?: string;
407
- body?: {
408
- [key: string]: any;
409
- };
410
- code?: string;
411
- status?: "succeeded" | "failed";
412
- start_date?: string;
413
- end_date?: string;
414
- event_id: string;
415
- }
416
- /**
417
- * A condition that must be met for the webhook to fire.
418
- */
419
- export interface WebhookCondition {
420
- /**
421
- * Dot-notation path to the field in the event payload (e.g. "entity.status", "entity.line_items")
422
- */
423
- field: string;
424
- operation: "equals" | "not_equals" | "any_of" | "none_of" | "contains" | "not_contains" | "starts_with" | "ends_with" | "greater_than" | "less_than" | "greater_than_or_equals" | "less_than_or_equals" | "is_empty" | "is_not_empty";
425
- /**
426
- * Values to compare against (not required for is_empty/is_not_empty)
427
- */
428
- values?: string[];
429
- /**
430
- * Type hint for the field (affects comparison logic)
431
- */
432
- field_type?: "string" | "number" | "boolean" | "date" | "datetime";
433
- /**
434
- * Whether the target field is an array (repeatable)
435
- */
436
- is_array_field?: boolean;
437
- /**
438
- * When true, evaluates conditions per-item in repeatable array fields
439
- */
440
- repeatable_item_op?: boolean;
441
- }
442
- /**
443
- * A group of conditions with a logical operator. Multiple conditions are AND-ed by default.
444
- */
445
- export interface WebhookConditionGroup {
446
- conditions?: [
447
- /* A condition that must be met for the webhook to fire. */ WebhookCondition?,
448
- /* A condition that must be met for the webhook to fire. */ WebhookCondition?,
449
- /* A condition that must be met for the webhook to fire. */ WebhookCondition?,
450
- /* A condition that must be met for the webhook to fire. */ WebhookCondition?,
451
- /* A condition that must be met for the webhook to fire. */ WebhookCondition?,
452
- /* A condition that must be met for the webhook to fire. */ WebhookCondition?,
453
- /* A condition that must be met for the webhook to fire. */ WebhookCondition?,
454
- /* A condition that must be met for the webhook to fire. */ WebhookCondition?,
455
- /* A condition that must be met for the webhook to fire. */ WebhookCondition?,
456
- /* A condition that must be met for the webhook to fire. */ WebhookCondition?
457
- ];
458
- logical_operator?: "AND" | "OR";
459
- }
460
- /**
461
- * example:
462
- * {
463
- * "eventName": "CustomerRequest_Created",
464
- * "url": "https://my-partner-service.api.com",
465
- * "httpMethod": "POST",
466
- * "enabled": true,
467
- * "auth": {
468
- * "authType": "BASIC",
469
- * "basicAuthConfig": {
470
- * "username": "secretUsername",
471
- * "password": "secret7825@!"
472
- * }
473
- * },
474
- * "filter": {
475
- * "keyToFilter": "customer_request.productId",
476
- * "supportedValues": [
477
- * "2324245",
478
- * "5253642"
479
- * ]
480
- * }
481
- * }
482
- */
483
- export interface WebhookConfig {
484
- id?: string;
485
- name: string;
486
- eventName: string;
487
- url?: string;
488
- /**
489
- * creation timestamp
490
- * example:
491
- * 2021-04-27T12:01:13.000Z
492
- */
493
- creationTime?: string;
494
- httpMethod?: HttpMethod;
495
- enabled?: boolean;
496
- auth?: Auth;
497
- filter?: Filter;
498
- payloadConfiguration?: /* Configuration for the webhook payload */ PayloadConfiguration;
499
- enableStaticIP?: boolean;
500
- /**
501
- * When true, indicates this webhook configuration is protected and should not be modified without explicit intent.
502
- */
503
- protected?: boolean;
504
- /**
505
- * Routes webhook requests through a secure VPC proxy (ERP integration service). When set, takes precedence over enableStaticIP.
506
- */
507
- secureProxy?: {
508
- integration_id: string; // uuid
509
- use_case_slug: string;
510
- };
511
- status?: "active" | "inactive" | "incomplete";
512
- /**
513
- * JSONata expression to transform the payload
514
- */
515
- jsonataExpression?: string;
516
- filterConditions?: /* A group of conditions with a logical operator. Multiple conditions are AND-ed by default. */ WebhookConditionGroup;
517
- /**
518
- * Manifest ID used to create/update the webhook resource
519
- */
520
- _manifest?: string /* uuid */[];
521
- /**
522
- * Per-webhook signing secret following the Standard Webhooks specification.
523
- * Only returned once during webhook creation. Use this secret to verify
524
- * webhook signatures using the `webhook-id`, `webhook-timestamp`, and
525
- * `webhook-signature` headers.
526
- *
527
- * example:
528
- * whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD
529
- */
530
- signingSecret?: string;
531
- }
532
- export interface WebhookEvent {
533
- event_id: string;
534
- org_id: string;
535
- webhook_config_id: string;
536
- url?: string;
537
- /**
538
- * example:
539
- * 2021-04-27T12:01:13.000Z
540
- */
541
- created_at?: string;
542
- event_name?: string;
543
- http_response?: {
544
- status_code?: number;
545
- message?: string;
546
- body?: {
547
- [key: string]: any;
548
- };
549
- code?: string;
550
- };
551
- metadata?: /* Contains the metadata about the configured event */ Metadata;
552
- status?: "succeeded" | "failed" | "in_progress" | "skipped";
553
- http_method?: "GET" | "POST" | "PUT";
554
- /**
555
- * stringified payload of the webhook request
556
- */
557
- payload?: string;
558
- }
559
- }
560
- }
561
- declare namespace Paths {
562
- namespace BatchReplayEvents {
563
- namespace Parameters {
564
- export type ConfigId = string;
565
- }
566
- export interface PathParameters {
567
- configId: Parameters.ConfigId;
568
- }
569
- export type RequestBody = Components.Schemas.BatchReplayRequest;
570
- namespace Responses {
571
- export interface $202 {
572
- /**
573
- * List of event ids that were enqueued for replay
574
- */
575
- replayed_event_ids?: string[];
576
- }
577
- export type $400 = Components.Schemas.ErrorResp;
578
- export type $404 = Components.Schemas.ErrorResp;
579
- export type $500 = Components.Schemas.ErrorResp;
580
- }
581
- }
582
- namespace CreateConfig {
583
- export type RequestBody = /**
584
- * example:
585
- * {
586
- * "eventName": "CustomerRequest_Created",
587
- * "url": "https://my-partner-service.api.com",
588
- * "httpMethod": "POST",
589
- * "enabled": true,
590
- * "auth": {
591
- * "authType": "BASIC",
592
- * "basicAuthConfig": {
593
- * "username": "secretUsername",
594
- * "password": "secret7825@!"
595
- * }
596
- * },
597
- * "filter": {
598
- * "keyToFilter": "customer_request.productId",
599
- * "supportedValues": [
600
- * "2324245",
601
- * "5253642"
602
- * ]
603
- * }
604
- * }
605
- */
606
- Components.Schemas.WebhookConfig;
607
- namespace Responses {
608
- export type $201 = /**
609
- * example:
610
- * {
611
- * "eventName": "CustomerRequest_Created",
612
- * "url": "https://my-partner-service.api.com",
613
- * "httpMethod": "POST",
614
- * "enabled": true,
615
- * "auth": {
616
- * "authType": "BASIC",
617
- * "basicAuthConfig": {
618
- * "username": "secretUsername",
619
- * "password": "secret7825@!"
620
- * }
621
- * },
622
- * "filter": {
623
- * "keyToFilter": "customer_request.productId",
624
- * "supportedValues": [
625
- * "2324245",
626
- * "5253642"
627
- * ]
628
- * }
629
- * }
630
- */
631
- Components.Schemas.WebhookConfig;
632
- export type $400 = Components.Schemas.ErrorResp;
633
- export type $401 = Components.Schemas.ErrorResp;
634
- export type $500 = Components.Schemas.ErrorResp;
635
- }
636
- }
637
- namespace DeleteConfig {
638
- namespace Parameters {
639
- export type ConfigId = string;
640
- }
641
- export interface PathParameters {
642
- configId: Parameters.ConfigId;
643
- }
644
- namespace Responses {
645
- export interface $204 {
646
- }
647
- export type $401 = Components.Schemas.ErrorResp;
648
- export interface $404 {
649
- }
650
- }
651
- }
652
- namespace GetConfig {
653
- namespace Parameters {
654
- export type ConfigId = string;
655
- }
656
- export interface PathParameters {
657
- configId: Parameters.ConfigId;
658
- }
659
- namespace Responses {
660
- export type $200 = /**
661
- * example:
662
- * {
663
- * "eventName": "CustomerRequest_Created",
664
- * "url": "https://my-partner-service.api.com",
665
- * "httpMethod": "POST",
666
- * "enabled": true,
667
- * "auth": {
668
- * "authType": "BASIC",
669
- * "basicAuthConfig": {
670
- * "username": "secretUsername",
671
- * "password": "secret7825@!"
672
- * }
673
- * },
674
- * "filter": {
675
- * "keyToFilter": "customer_request.productId",
676
- * "supportedValues": [
677
- * "2324245",
678
- * "5253642"
679
- * ]
680
- * }
681
- * }
682
- */
683
- Components.Schemas.WebhookConfig;
684
- export type $404 = Components.Schemas.ErrorResp;
685
- export type $500 = Components.Schemas.ErrorResp;
686
- }
687
- }
688
- namespace GetConfigs {
689
- namespace Parameters {
690
- export type EventName = string;
691
- }
692
- export interface QueryParameters {
693
- eventName?: Parameters.EventName;
694
- }
695
- namespace Responses {
696
- export type $200 = /**
697
- * example:
698
- * {
699
- * "eventName": "CustomerRequest_Created",
700
- * "url": "https://my-partner-service.api.com",
701
- * "httpMethod": "POST",
702
- * "enabled": true,
703
- * "auth": {
704
- * "authType": "BASIC",
705
- * "basicAuthConfig": {
706
- * "username": "secretUsername",
707
- * "password": "secret7825@!"
708
- * }
709
- * },
710
- * "filter": {
711
- * "keyToFilter": "customer_request.productId",
712
- * "supportedValues": [
713
- * "2324245",
714
- * "5253642"
715
- * ]
716
- * }
717
- * }
718
- */
719
- Components.Schemas.WebhookConfig[];
720
- export type $500 = Components.Schemas.ErrorResp;
721
- }
722
- }
723
- namespace GetConfiguredEvents {
724
- namespace Responses {
725
- export type $200 = /**
726
- * example:
727
- * [
728
- * {
729
- * "eventName": "customer_request_created",
730
- * "eventLabel": "Customer Request Created"
731
- * }
732
- * ]
733
- */
734
- Components.Schemas.EventConfigResp;
735
- }
736
- }
737
- namespace GetEventById {
738
- namespace Parameters {
739
- export type ConfigId = string;
740
- export type EventId = string;
741
- }
742
- export interface PathParameters {
743
- configId: Parameters.ConfigId;
744
- eventId: Parameters.EventId;
745
- }
746
- namespace Responses {
747
- export type $200 = Components.Schemas.WebhookEvent;
748
- export type $404 = Components.Schemas.ErrorResp;
749
- export type $500 = Components.Schemas.ErrorResp;
750
- }
751
- }
752
- namespace GetPublicKey {
753
- namespace Parameters {
754
- export type OrgId = string;
755
- }
756
- export interface QueryParameters {
757
- orgId: Parameters.OrgId;
758
- }
759
- namespace Responses {
760
- export type $200 = Components.Schemas.PublicKeyResponse;
761
- export type $500 = Components.Schemas.ErrorResp;
762
- }
763
- }
764
- namespace GetWebhookEventsV2 {
765
- namespace Parameters {
766
- export type ConfigId = string;
767
- }
768
- export interface PathParameters {
769
- configId: Parameters.ConfigId;
770
- }
771
- export type RequestBody = Components.Schemas.SearchOptions;
772
- namespace Responses {
773
- export type $200 = Components.Schemas.EventListResponse;
774
- }
775
- }
776
- namespace GetWebhookExample {
777
- namespace Parameters {
778
- export type ConfigId = string;
779
- }
780
- export interface PathParameters {
781
- configId: Parameters.ConfigId;
782
- }
783
- export type RequestBody = Components.Schemas.ExampleRequest;
784
- namespace Responses {
785
- export type $200 = Components.Schemas.ExampleResponse;
786
- export type $400 = Components.Schemas.ErrorResp;
787
- export type $404 = Components.Schemas.ErrorResp;
788
- export type $500 = Components.Schemas.ErrorResp;
789
- }
790
- }
791
- namespace GetWehookEvents {
792
- namespace Parameters {
793
- export type ConfigId = string;
794
- export type Cursor = string;
795
- export type Status = "succeeded" | "failed" | "in_progress";
796
- }
797
- export interface PathParameters {
798
- configId: Parameters.ConfigId;
799
- }
800
- export interface QueryParameters {
801
- status?: Parameters.Status;
802
- cursor?: Parameters.Cursor;
803
- }
804
- namespace Responses {
805
- export interface $200 {
806
- data?: Components.Schemas.WebhookEvent[];
807
- /**
808
- * Cursor to be used for pagination
809
- */
810
- cursor?: string;
811
- }
812
- export type $404 = Components.Schemas.ErrorResp;
813
- export type $500 = Components.Schemas.ErrorResp;
814
- }
815
- }
816
- namespace ReplayEvent {
817
- namespace Parameters {
818
- export type ConfigId = string;
819
- export type EventId = string;
820
- }
821
- export interface PathParameters {
822
- configId: Parameters.ConfigId;
823
- eventId: Parameters.EventId;
824
- }
825
- namespace Responses {
826
- export interface $204 {
827
- }
828
- export type $404 = Components.Schemas.ErrorResp;
829
- export type $500 = Components.Schemas.ErrorResp;
830
- }
831
- }
832
- namespace TriggerWebhook {
833
- namespace Parameters {
834
- export type ConfigId = string;
835
- export type Sync = boolean;
836
- }
837
- export interface PathParameters {
838
- configId: Parameters.ConfigId;
839
- }
840
- export interface QueryParameters {
841
- sync?: Parameters.Sync;
842
- }
843
- export type RequestBody = /* Payload for triggering a webhook */ Components.Schemas.ExecutionPayload;
844
- namespace Responses {
845
- export type $200 = Components.Schemas.TriggerWebhookResp;
846
- export type $400 = Components.Schemas.ErrorResp;
847
- export type $500 = Components.Schemas.ErrorResp;
848
- }
849
- }
850
- namespace UpdateConfig {
851
- namespace Parameters {
852
- export type ConfigId = string;
853
- }
854
- export interface PathParameters {
855
- configId: Parameters.ConfigId;
856
- }
857
- export type RequestBody = /**
858
- * example:
859
- * {
860
- * "eventName": "CustomerRequest_Created",
861
- * "url": "https://my-partner-service.api.com",
862
- * "httpMethod": "POST",
863
- * "enabled": true,
864
- * "auth": {
865
- * "authType": "BASIC",
866
- * "basicAuthConfig": {
867
- * "username": "secretUsername",
868
- * "password": "secret7825@!"
869
- * }
870
- * },
871
- * "filter": {
872
- * "keyToFilter": "customer_request.productId",
873
- * "supportedValues": [
874
- * "2324245",
875
- * "5253642"
876
- * ]
877
- * }
878
- * }
879
- */
880
- Components.Schemas.WebhookConfig;
881
- namespace Responses {
882
- export type $200 = /**
883
- * example:
884
- * {
885
- * "eventName": "CustomerRequest_Created",
886
- * "url": "https://my-partner-service.api.com",
887
- * "httpMethod": "POST",
888
- * "enabled": true,
889
- * "auth": {
890
- * "authType": "BASIC",
891
- * "basicAuthConfig": {
892
- * "username": "secretUsername",
893
- * "password": "secret7825@!"
894
- * }
895
- * },
896
- * "filter": {
897
- * "keyToFilter": "customer_request.productId",
898
- * "supportedValues": [
899
- * "2324245",
900
- * "5253642"
901
- * ]
902
- * }
903
- * }
904
- */
905
- Components.Schemas.WebhookConfig;
906
- export type $400 = Components.Schemas.ErrorResp;
907
- export type $401 = Components.Schemas.ErrorResp;
908
- export type $500 = Components.Schemas.ErrorResp;
909
- }
910
- }
911
- }
912
-
913
-
914
- interface OperationMethods {
915
- /**
916
- * getPublicKey - getPublicKey
917
- *
918
- * Returns the platform-level Ed25519 public key used to verify
919
- * asymmetric (v1a) webhook signatures. This endpoint is unauthenticated since the public key is not a secret, but the orgId parameter is required to ensure clients retrieve the correct key for their organization in case of key rotation.
920
- *
921
- */
922
- 'getPublicKey'(
923
- parameters?: Parameters<Paths.GetPublicKey.QueryParameters> | null,
924
- data?: any,
925
- config?: AxiosRequestConfig
926
- ): OperationResponse<Paths.GetPublicKey.Responses.$200>
927
- /**
928
- * getConfiguredEvents - getConfiguredEvents
929
- *
930
- * Retrieve events that can trigger webhooks
931
- */
932
- 'getConfiguredEvents'(
933
- parameters?: Parameters<UnknownParamsObject> | null,
934
- data?: any,
935
- config?: AxiosRequestConfig
936
- ): OperationResponse<Paths.GetConfiguredEvents.Responses.$200>
937
- /**
938
- * getConfigs - getConfigs
939
- *
940
- * Search Webhook Client Configs
941
- */
942
- 'getConfigs'(
943
- parameters?: Parameters<Paths.GetConfigs.QueryParameters> | null,
944
- data?: any,
945
- config?: AxiosRequestConfig
946
- ): OperationResponse<Paths.GetConfigs.Responses.$200>
947
- /**
948
- * createConfig - createConfig
949
- *
950
- * Create Webhook Client Config
951
- */
952
- 'createConfig'(
953
- parameters?: Parameters<UnknownParamsObject> | null,
954
- data?: Paths.CreateConfig.RequestBody,
955
- config?: AxiosRequestConfig
956
- ): OperationResponse<Paths.CreateConfig.Responses.$201>
957
- /**
958
- * getConfig - getConfig
959
- *
960
- * Get webhook config by id
961
- */
962
- 'getConfig'(
963
- parameters?: Parameters<Paths.GetConfig.PathParameters> | null,
964
- data?: any,
965
- config?: AxiosRequestConfig
966
- ): OperationResponse<Paths.GetConfig.Responses.$200>
967
- /**
968
- * updateConfig - updateConfig
969
- *
970
- * Update Webhook Client Config
971
- */
972
- 'updateConfig'(
973
- parameters?: Parameters<Paths.UpdateConfig.PathParameters> | null,
974
- data?: Paths.UpdateConfig.RequestBody,
975
- config?: AxiosRequestConfig
976
- ): OperationResponse<Paths.UpdateConfig.Responses.$200>
977
- /**
978
- * deleteConfig - deleteConfig
979
- *
980
- * Delete Webhook Client Config
981
- */
982
- 'deleteConfig'(
983
- parameters?: Parameters<Paths.DeleteConfig.PathParameters> | null,
984
- data?: any,
985
- config?: AxiosRequestConfig
986
- ): OperationResponse<Paths.DeleteConfig.Responses.$204>
987
- /**
988
- * triggerWebhook - triggers a webhook event either async or sync
989
- *
990
- * Trigger a webhook
991
- */
992
- 'triggerWebhook'(
993
- parameters?: Parameters<Paths.TriggerWebhook.QueryParameters & Paths.TriggerWebhook.PathParameters> | null,
994
- data?: Paths.TriggerWebhook.RequestBody,
995
- config?: AxiosRequestConfig
996
- ): OperationResponse<Paths.TriggerWebhook.Responses.$200>
997
- /**
998
- * getWehookEvents - getWehookEvents
999
- *
1000
- * This endpoint is deprecated and will be removed on 2025-12-31. Use /v2/webhooks/configs/{configId}/events instead.
1001
- */
1002
- 'getWehookEvents'(
1003
- parameters?: Parameters<Paths.GetWehookEvents.QueryParameters & Paths.GetWehookEvents.PathParameters> | null,
1004
- data?: any,
1005
- config?: AxiosRequestConfig
1006
- ): OperationResponse<Paths.GetWehookEvents.Responses.$200>
1007
- /**
1008
- * batchReplayEvents - batchReplayEvents
1009
- *
1010
- * Replay a batch of webhook events
1011
- */
1012
- 'batchReplayEvents'(
1013
- parameters?: Parameters<Paths.BatchReplayEvents.PathParameters> | null,
1014
- data?: Paths.BatchReplayEvents.RequestBody,
1015
- config?: AxiosRequestConfig
1016
- ): OperationResponse<Paths.BatchReplayEvents.Responses.$202>
1017
- /**
1018
- * getEventById - getEventById
1019
- *
1020
- * Get a webhook event by its id
1021
- */
1022
- 'getEventById'(
1023
- parameters?: Parameters<Paths.GetEventById.PathParameters> | null,
1024
- data?: any,
1025
- config?: AxiosRequestConfig
1026
- ): OperationResponse<Paths.GetEventById.Responses.$200>
1027
- /**
1028
- * replayEvent - replayEvent
1029
- *
1030
- * Replay a webhook event
1031
- */
1032
- 'replayEvent'(
1033
- parameters?: Parameters<Paths.ReplayEvent.PathParameters> | null,
1034
- data?: any,
1035
- config?: AxiosRequestConfig
1036
- ): OperationResponse<Paths.ReplayEvent.Responses.$204>
1037
- /**
1038
- * getWebhookExample - getWebhookExample
1039
- *
1040
- * Generate an example payload for a webhook configuration based on trigger type
1041
- */
1042
- 'getWebhookExample'(
1043
- parameters?: Parameters<Paths.GetWebhookExample.PathParameters> | null,
1044
- data?: Paths.GetWebhookExample.RequestBody,
1045
- config?: AxiosRequestConfig
1046
- ): OperationResponse<Paths.GetWebhookExample.Responses.$200>
1047
- /**
1048
- * getWebhookEventsV2 - getWebhookEventsV2
1049
- *
1050
- * List webhook events and filter them by status, timestamp, etc.
1051
- */
1052
- 'getWebhookEventsV2'(
1053
- parameters?: Parameters<Paths.GetWebhookEventsV2.PathParameters> | null,
1054
- data?: Paths.GetWebhookEventsV2.RequestBody,
1055
- config?: AxiosRequestConfig
1056
- ): OperationResponse<Paths.GetWebhookEventsV2.Responses.$200>
1057
- }
1058
-
1059
- interface PathsDictionary {
1060
- ['/v1/webhooks/.well-known/public-key']: {
1061
- /**
1062
- * getPublicKey - getPublicKey
1063
- *
1064
- * Returns the platform-level Ed25519 public key used to verify
1065
- * asymmetric (v1a) webhook signatures. This endpoint is unauthenticated since the public key is not a secret, but the orgId parameter is required to ensure clients retrieve the correct key for their organization in case of key rotation.
1066
- *
1067
- */
1068
- 'get'(
1069
- parameters?: Parameters<Paths.GetPublicKey.QueryParameters> | null,
1070
- data?: any,
1071
- config?: AxiosRequestConfig
1072
- ): OperationResponse<Paths.GetPublicKey.Responses.$200>
1073
- }
1074
- ['/v1/webhooks/configured-events']: {
1075
- /**
1076
- * getConfiguredEvents - getConfiguredEvents
1077
- *
1078
- * Retrieve events that can trigger webhooks
1079
- */
1080
- 'get'(
1081
- parameters?: Parameters<UnknownParamsObject> | null,
1082
- data?: any,
1083
- config?: AxiosRequestConfig
1084
- ): OperationResponse<Paths.GetConfiguredEvents.Responses.$200>
1085
- }
1086
- ['/v1/webhooks/configs']: {
1087
- /**
1088
- * getConfigs - getConfigs
1089
- *
1090
- * Search Webhook Client Configs
1091
- */
1092
- 'get'(
1093
- parameters?: Parameters<Paths.GetConfigs.QueryParameters> | null,
1094
- data?: any,
1095
- config?: AxiosRequestConfig
1096
- ): OperationResponse<Paths.GetConfigs.Responses.$200>
1097
- /**
1098
- * createConfig - createConfig
1099
- *
1100
- * Create Webhook Client Config
1101
- */
1102
- 'post'(
1103
- parameters?: Parameters<UnknownParamsObject> | null,
1104
- data?: Paths.CreateConfig.RequestBody,
1105
- config?: AxiosRequestConfig
1106
- ): OperationResponse<Paths.CreateConfig.Responses.$201>
1107
- }
1108
- ['/v1/webhooks/configs/{configId}']: {
1109
- /**
1110
- * getConfig - getConfig
1111
- *
1112
- * Get webhook config by id
1113
- */
1114
- 'get'(
1115
- parameters?: Parameters<Paths.GetConfig.PathParameters> | null,
1116
- data?: any,
1117
- config?: AxiosRequestConfig
1118
- ): OperationResponse<Paths.GetConfig.Responses.$200>
1119
- /**
1120
- * updateConfig - updateConfig
1121
- *
1122
- * Update Webhook Client Config
1123
- */
1124
- 'put'(
1125
- parameters?: Parameters<Paths.UpdateConfig.PathParameters> | null,
1126
- data?: Paths.UpdateConfig.RequestBody,
1127
- config?: AxiosRequestConfig
1128
- ): OperationResponse<Paths.UpdateConfig.Responses.$200>
1129
- /**
1130
- * deleteConfig - deleteConfig
1131
- *
1132
- * Delete Webhook Client Config
1133
- */
1134
- 'delete'(
1135
- parameters?: Parameters<Paths.DeleteConfig.PathParameters> | null,
1136
- data?: any,
1137
- config?: AxiosRequestConfig
1138
- ): OperationResponse<Paths.DeleteConfig.Responses.$204>
1139
- }
1140
- ['/v1/webhooks/configs/{configId}/trigger']: {
1141
- /**
1142
- * triggerWebhook - triggers a webhook event either async or sync
1143
- *
1144
- * Trigger a webhook
1145
- */
1146
- 'post'(
1147
- parameters?: Parameters<Paths.TriggerWebhook.QueryParameters & Paths.TriggerWebhook.PathParameters> | null,
1148
- data?: Paths.TriggerWebhook.RequestBody,
1149
- config?: AxiosRequestConfig
1150
- ): OperationResponse<Paths.TriggerWebhook.Responses.$200>
1151
- }
1152
- ['/v1/webhooks/configs/{configId}/events']: {
1153
- /**
1154
- * getWehookEvents - getWehookEvents
1155
- *
1156
- * This endpoint is deprecated and will be removed on 2025-12-31. Use /v2/webhooks/configs/{configId}/events instead.
1157
- */
1158
- 'get'(
1159
- parameters?: Parameters<Paths.GetWehookEvents.QueryParameters & Paths.GetWehookEvents.PathParameters> | null,
1160
- data?: any,
1161
- config?: AxiosRequestConfig
1162
- ): OperationResponse<Paths.GetWehookEvents.Responses.$200>
1163
- }
1164
- ['/v1/webhooks/configs/{configId}/events/replay-batch']: {
1165
- /**
1166
- * batchReplayEvents - batchReplayEvents
1167
- *
1168
- * Replay a batch of webhook events
1169
- */
1170
- 'post'(
1171
- parameters?: Parameters<Paths.BatchReplayEvents.PathParameters> | null,
1172
- data?: Paths.BatchReplayEvents.RequestBody,
1173
- config?: AxiosRequestConfig
1174
- ): OperationResponse<Paths.BatchReplayEvents.Responses.$202>
1175
- }
1176
- ['/v1/webhooks/configs/{configId}/events/{eventId}']: {
1177
- /**
1178
- * getEventById - getEventById
1179
- *
1180
- * Get a webhook event by its id
1181
- */
1182
- 'get'(
1183
- parameters?: Parameters<Paths.GetEventById.PathParameters> | null,
1184
- data?: any,
1185
- config?: AxiosRequestConfig
1186
- ): OperationResponse<Paths.GetEventById.Responses.$200>
1187
- }
1188
- ['/v1/webhooks/configs/{configId}/events/{eventId}/replay']: {
1189
- /**
1190
- * replayEvent - replayEvent
1191
- *
1192
- * Replay a webhook event
1193
- */
1194
- 'post'(
1195
- parameters?: Parameters<Paths.ReplayEvent.PathParameters> | null,
1196
- data?: any,
1197
- config?: AxiosRequestConfig
1198
- ): OperationResponse<Paths.ReplayEvent.Responses.$204>
1199
- }
1200
- ['/v1/webhooks/configs/{configId}/example']: {
1201
- /**
1202
- * getWebhookExample - getWebhookExample
1203
- *
1204
- * Generate an example payload for a webhook configuration based on trigger type
1205
- */
1206
- 'post'(
1207
- parameters?: Parameters<Paths.GetWebhookExample.PathParameters> | null,
1208
- data?: Paths.GetWebhookExample.RequestBody,
1209
- config?: AxiosRequestConfig
1210
- ): OperationResponse<Paths.GetWebhookExample.Responses.$200>
1211
- }
1212
- ['/v2/webhooks/configs/{configId}/events']: {
1213
- /**
1214
- * getWebhookEventsV2 - getWebhookEventsV2
1215
- *
1216
- * List webhook events and filter them by status, timestamp, etc.
1217
- */
1218
- 'post'(
1219
- parameters?: Parameters<Paths.GetWebhookEventsV2.PathParameters> | null,
1220
- data?: Paths.GetWebhookEventsV2.RequestBody,
1221
- config?: AxiosRequestConfig
1222
- ): OperationResponse<Paths.GetWebhookEventsV2.Responses.$200>
1223
- }
1224
- }
1225
-
1226
- type Client = OpenAPIClient<OperationMethods, PathsDictionary>
1227
-
1228
-
1229
- type ApiKeyConfig = Components.Schemas.ApiKeyConfig;
1230
- type Auth = Components.Schemas.Auth;
1231
- type AuthType = Components.Schemas.AuthType;
1232
- type BasicAuthConfig = Components.Schemas.BasicAuthConfig;
1233
- type BatchReplayRequest = Components.Schemas.BatchReplayRequest;
1234
- type CustomHeader = Components.Schemas.CustomHeader;
1235
- type CustomOAuthParameter = Components.Schemas.CustomOAuthParameter;
1236
- type ErrorResp = Components.Schemas.ErrorResp;
1237
- type EventConfigEntry = Components.Schemas.EventConfigEntry;
1238
- type EventConfigResp = Components.Schemas.EventConfigResp;
1239
- type EventListResponse = Components.Schemas.EventListResponse;
1240
- type ExampleRequest = Components.Schemas.ExampleRequest;
1241
- type ExampleResponse = Components.Schemas.ExampleResponse;
1242
- type ExecutionPayload = Components.Schemas.ExecutionPayload;
1243
- type Filter = Components.Schemas.Filter;
1244
- type HttpMethod = Components.Schemas.HttpMethod;
1245
- type Metadata = Components.Schemas.Metadata;
1246
- type OAuthConfig = Components.Schemas.OAuthConfig;
1247
- type PayloadConfiguration = Components.Schemas.PayloadConfiguration;
1248
- type PublicKeyResponse = Components.Schemas.PublicKeyResponse;
1249
- type SearchOptions = Components.Schemas.SearchOptions;
1250
- type TriggerWebhookResp = Components.Schemas.TriggerWebhookResp;
1251
- type WebhookCondition = Components.Schemas.WebhookCondition;
1252
- type WebhookConditionGroup = Components.Schemas.WebhookConditionGroup;
1253
- type WebhookConfig = Components.Schemas.WebhookConfig;
1254
- type WebhookEvent = Components.Schemas.WebhookEvent;
1255
-
1256
- export { type ApiKeyConfig as A, type BasicAuthConfig as B, type Client as C, type ErrorResp as E, type Filter as F, type HttpMethod as H, type Metadata as M, type OperationMethods as O, Paths as P, type SearchOptions as S, type TriggerWebhookResp as T, type WebhookCondition as W, Components as a, type PathsDictionary as b, type Auth as c, type AuthType as d, type BatchReplayRequest as e, type CustomHeader as f, type CustomOAuthParameter as g, type EventConfigEntry as h, type EventConfigResp as i, type EventListResponse as j, type ExampleRequest as k, type ExampleResponse as l, type ExecutionPayload as m, type OAuthConfig as n, type PayloadConfiguration as o, type PublicKeyResponse as p, type WebhookConditionGroup as q, type WebhookConfig as r, type WebhookEvent as s };