@epilot/sdk 2.4.4-alpha.0 → 2.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (381) hide show
  1. package/definitions/app.json +137 -58
  2. package/definitions/customer-portal-runtime.json +1 -1
  3. package/definitions/customer-portal.json +496 -24
  4. package/definitions/entity.json +185 -8
  5. package/definitions/webhooks-runtime.json +1 -1
  6. package/definitions/webhooks.json +134 -4
  7. package/dist/access-token.d-CnmUTOlq.d.cts +552 -0
  8. package/dist/access-token.d-CnmUTOlq.d.ts +552 -0
  9. package/dist/address-suggestions.d-_YwTOR-9.d.cts +339 -0
  10. package/dist/address-suggestions.d-_YwTOR-9.d.ts +339 -0
  11. package/dist/address.d-CwAPOVxa.d.cts +437 -0
  12. package/dist/address.d-CwAPOVxa.d.ts +437 -0
  13. package/dist/ai-agents.d-OkXfr2bz.d.cts +1339 -0
  14. package/dist/ai-agents.d-OkXfr2bz.d.ts +1339 -0
  15. package/dist/apis/access-token.cjs +6 -6
  16. package/dist/apis/access-token.d.cts +18 -0
  17. package/dist/apis/access-token.d.ts +12 -9
  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.cts +18 -0
  21. package/dist/apis/address-suggestions.d.ts +12 -9
  22. package/dist/apis/address-suggestions.js +1 -1
  23. package/dist/apis/address.cjs +6 -6
  24. package/dist/apis/address.d.cts +18 -0
  25. package/dist/apis/address.d.ts +12 -9
  26. package/dist/apis/address.js +1 -1
  27. package/dist/apis/ai-agents.cjs +6 -6
  28. package/dist/apis/ai-agents.d.cts +18 -0
  29. package/dist/apis/ai-agents.d.ts +12 -9
  30. package/dist/apis/ai-agents.js +1 -1
  31. package/dist/apis/app.cjs +8 -8
  32. package/dist/apis/app.d.cts +18 -0
  33. package/dist/apis/app.d.ts +12 -9
  34. package/dist/apis/app.js +2 -2
  35. package/dist/apis/audit-logs.cjs +6 -6
  36. package/dist/apis/audit-logs.d.cts +18 -0
  37. package/dist/apis/audit-logs.d.ts +12 -9
  38. package/dist/apis/audit-logs.js +1 -1
  39. package/dist/apis/automation.cjs +6 -6
  40. package/dist/apis/automation.d.cts +18 -0
  41. package/dist/apis/automation.d.ts +12 -9
  42. package/dist/apis/automation.js +1 -1
  43. package/dist/apis/billing.cjs +6 -6
  44. package/dist/apis/billing.d.cts +18 -0
  45. package/dist/apis/billing.d.ts +12 -9
  46. package/dist/apis/billing.js +1 -1
  47. package/dist/apis/blueprint-manifest.cjs +6 -6
  48. package/dist/apis/blueprint-manifest.d.cts +18 -0
  49. package/dist/apis/blueprint-manifest.d.ts +12 -9
  50. package/dist/apis/blueprint-manifest.js +1 -1
  51. package/dist/apis/calendar.cjs +6 -6
  52. package/dist/apis/calendar.d.cts +18 -0
  53. package/dist/apis/calendar.d.ts +12 -9
  54. package/dist/apis/calendar.js +1 -1
  55. package/dist/apis/configuration-hub.cjs +6 -6
  56. package/dist/apis/configuration-hub.d.cts +18 -0
  57. package/dist/apis/configuration-hub.d.ts +12 -9
  58. package/dist/apis/configuration-hub.js +1 -1
  59. package/dist/apis/consent.cjs +6 -6
  60. package/dist/apis/consent.d.cts +18 -0
  61. package/dist/apis/consent.d.ts +12 -9
  62. package/dist/apis/consent.js +1 -1
  63. package/dist/apis/customer-portal.cjs +8 -8
  64. package/dist/apis/customer-portal.d.cts +18 -0
  65. package/dist/apis/customer-portal.d.ts +12 -9
  66. package/dist/apis/customer-portal.js +2 -2
  67. package/dist/apis/dashboard.cjs +6 -6
  68. package/dist/apis/dashboard.d.cts +18 -0
  69. package/dist/apis/dashboard.d.ts +12 -9
  70. package/dist/apis/dashboard.js +1 -1
  71. package/dist/apis/data-governance.cjs +6 -6
  72. package/dist/apis/data-governance.d.cts +18 -0
  73. package/dist/apis/data-governance.d.ts +12 -9
  74. package/dist/apis/data-governance.js +1 -1
  75. package/dist/apis/deduplication.cjs +6 -6
  76. package/dist/apis/deduplication.d.cts +18 -0
  77. package/dist/apis/deduplication.d.ts +12 -9
  78. package/dist/apis/deduplication.js +1 -1
  79. package/dist/apis/design.cjs +6 -6
  80. package/dist/apis/design.d.cts +18 -0
  81. package/dist/apis/design.d.ts +12 -9
  82. package/dist/apis/design.js +1 -1
  83. package/dist/apis/document.cjs +6 -6
  84. package/dist/apis/document.d.cts +18 -0
  85. package/dist/apis/document.d.ts +12 -9
  86. package/dist/apis/document.js +1 -1
  87. package/dist/apis/email-settings.cjs +6 -6
  88. package/dist/apis/email-settings.d.cts +18 -0
  89. package/dist/apis/email-settings.d.ts +12 -9
  90. package/dist/apis/email-settings.js +1 -1
  91. package/dist/apis/email-template.cjs +6 -6
  92. package/dist/apis/email-template.d.cts +18 -0
  93. package/dist/apis/email-template.d.ts +12 -9
  94. package/dist/apis/email-template.js +1 -1
  95. package/dist/apis/entity-mapping.cjs +6 -6
  96. package/dist/apis/entity-mapping.d.cts +18 -0
  97. package/dist/apis/entity-mapping.d.ts +12 -9
  98. package/dist/apis/entity-mapping.js +1 -1
  99. package/dist/apis/entity.cjs +6 -6
  100. package/dist/apis/entity.d.cts +18 -0
  101. package/dist/apis/entity.d.ts +12 -9
  102. package/dist/apis/entity.js +1 -1
  103. package/dist/apis/environments.cjs +6 -6
  104. package/dist/apis/environments.d.cts +18 -0
  105. package/dist/apis/environments.d.ts +12 -9
  106. package/dist/apis/environments.js +1 -1
  107. package/dist/apis/event-catalog.cjs +6 -6
  108. package/dist/apis/event-catalog.d.cts +18 -0
  109. package/dist/apis/event-catalog.d.ts +12 -9
  110. package/dist/apis/event-catalog.js +1 -1
  111. package/dist/apis/file.cjs +6 -6
  112. package/dist/apis/file.d.cts +18 -0
  113. package/dist/apis/file.d.ts +12 -9
  114. package/dist/apis/file.js +1 -1
  115. package/dist/apis/iban.cjs +6 -6
  116. package/dist/apis/iban.d.cts +18 -0
  117. package/dist/apis/iban.d.ts +12 -9
  118. package/dist/apis/iban.js +1 -1
  119. package/dist/apis/integration-toolkit.cjs +6 -6
  120. package/dist/apis/integration-toolkit.d.cts +18 -0
  121. package/dist/apis/integration-toolkit.d.ts +12 -9
  122. package/dist/apis/integration-toolkit.js +1 -1
  123. package/dist/apis/journey.cjs +6 -6
  124. package/dist/apis/journey.d.cts +18 -0
  125. package/dist/apis/journey.d.ts +12 -9
  126. package/dist/apis/journey.js +1 -1
  127. package/dist/apis/kanban.cjs +6 -6
  128. package/dist/apis/kanban.d.cts +18 -0
  129. package/dist/apis/kanban.d.ts +12 -9
  130. package/dist/apis/kanban.js +1 -1
  131. package/dist/apis/message.cjs +6 -6
  132. package/dist/apis/message.d.cts +18 -0
  133. package/dist/apis/message.d.ts +12 -9
  134. package/dist/apis/message.js +1 -1
  135. package/dist/apis/metering.cjs +6 -6
  136. package/dist/apis/metering.d.cts +18 -0
  137. package/dist/apis/metering.d.ts +12 -9
  138. package/dist/apis/metering.js +1 -1
  139. package/dist/apis/notes.cjs +6 -6
  140. package/dist/apis/notes.d.cts +18 -0
  141. package/dist/apis/notes.d.ts +12 -9
  142. package/dist/apis/notes.js +1 -1
  143. package/dist/apis/notification.cjs +6 -6
  144. package/dist/apis/notification.d.cts +18 -0
  145. package/dist/apis/notification.d.ts +12 -9
  146. package/dist/apis/notification.js +1 -1
  147. package/dist/apis/organization.cjs +6 -6
  148. package/dist/apis/organization.d.cts +18 -0
  149. package/dist/apis/organization.d.ts +12 -9
  150. package/dist/apis/organization.js +1 -1
  151. package/dist/apis/partner-directory.cjs +6 -6
  152. package/dist/apis/partner-directory.d.cts +18 -0
  153. package/dist/apis/partner-directory.d.ts +12 -9
  154. package/dist/apis/partner-directory.js +1 -1
  155. package/dist/apis/permissions.cjs +6 -6
  156. package/dist/apis/permissions.d.cts +18 -0
  157. package/dist/apis/permissions.d.ts +12 -9
  158. package/dist/apis/permissions.js +1 -1
  159. package/dist/apis/pricing-tier.cjs +6 -6
  160. package/dist/apis/pricing-tier.d.cts +18 -0
  161. package/dist/apis/pricing-tier.d.ts +12 -9
  162. package/dist/apis/pricing-tier.js +1 -1
  163. package/dist/apis/pricing.cjs +6 -6
  164. package/dist/apis/pricing.d.cts +18 -0
  165. package/dist/apis/pricing.d.ts +12 -9
  166. package/dist/apis/pricing.js +1 -1
  167. package/dist/apis/purpose.cjs +6 -6
  168. package/dist/apis/purpose.d.cts +18 -0
  169. package/dist/apis/purpose.d.ts +12 -9
  170. package/dist/apis/purpose.js +1 -1
  171. package/dist/apis/query.cjs +6 -6
  172. package/dist/apis/query.d.cts +18 -0
  173. package/dist/apis/query.d.ts +12 -9
  174. package/dist/apis/query.js +1 -1
  175. package/dist/apis/sandbox.cjs +6 -6
  176. package/dist/apis/sandbox.d.cts +18 -0
  177. package/dist/apis/sandbox.d.ts +12 -9
  178. package/dist/apis/sandbox.js +1 -1
  179. package/dist/apis/sharing.cjs +6 -6
  180. package/dist/apis/sharing.d.cts +18 -0
  181. package/dist/apis/sharing.d.ts +12 -9
  182. package/dist/apis/sharing.js +1 -1
  183. package/dist/apis/submission.cjs +6 -6
  184. package/dist/apis/submission.d.cts +18 -0
  185. package/dist/apis/submission.d.ts +12 -9
  186. package/dist/apis/submission.js +1 -1
  187. package/dist/apis/target.cjs +6 -6
  188. package/dist/apis/target.d.cts +597 -0
  189. package/dist/apis/target.d.ts +591 -9
  190. package/dist/apis/target.js +1 -1
  191. package/dist/apis/targeting.cjs +6 -6
  192. package/dist/apis/targeting.d.cts +18 -0
  193. package/dist/apis/targeting.d.ts +12 -9
  194. package/dist/apis/targeting.js +1 -1
  195. package/dist/apis/template-variables.cjs +6 -6
  196. package/dist/apis/template-variables.d.cts +18 -0
  197. package/dist/apis/template-variables.d.ts +12 -9
  198. package/dist/apis/template-variables.js +1 -1
  199. package/dist/apis/user.cjs +6 -6
  200. package/dist/apis/user.d.cts +18 -0
  201. package/dist/apis/user.d.ts +12 -9
  202. package/dist/apis/user.js +1 -1
  203. package/dist/apis/validation-rules.cjs +6 -6
  204. package/dist/apis/validation-rules.d.cts +18 -0
  205. package/dist/apis/validation-rules.d.ts +12 -9
  206. package/dist/apis/validation-rules.js +1 -1
  207. package/dist/apis/webhooks.cjs +8 -8
  208. package/dist/apis/webhooks.d.cts +18 -0
  209. package/dist/apis/webhooks.d.ts +12 -9
  210. package/dist/apis/webhooks.js +2 -2
  211. package/dist/apis/workflow-definition.cjs +6 -6
  212. package/dist/apis/workflow-definition.d.cts +18 -0
  213. package/dist/apis/workflow-definition.d.ts +12 -9
  214. package/dist/apis/workflow-definition.js +1 -1
  215. package/dist/apis/workflow.cjs +6 -6
  216. package/dist/apis/workflow.d.cts +18 -0
  217. package/dist/apis/workflow.d.ts +12 -9
  218. package/dist/apis/workflow.js +1 -1
  219. package/dist/app-34OBBTA4.js +7 -0
  220. package/dist/app-SSF545U7.cjs +7 -0
  221. package/dist/app-runtime-AFNM67YN.cjs +5 -0
  222. package/dist/{app-runtime-U7RGV7KT.js → app-runtime-DBUXZL6E.js} +1 -1
  223. package/dist/app.d--5n0FQQ4.d.cts +3757 -0
  224. package/dist/app.d--5n0FQQ4.d.ts +3757 -0
  225. package/dist/audit-logs.d-BRToFqeX.d.cts +287 -0
  226. package/dist/audit-logs.d-BRToFqeX.d.ts +287 -0
  227. package/dist/automation.d-Du6-uiz5.d.cts +5283 -0
  228. package/dist/automation.d-Du6-uiz5.d.ts +5283 -0
  229. package/dist/billing.d-Bs8Ku9qE.d.cts +993 -0
  230. package/dist/billing.d-Bs8Ku9qE.d.ts +993 -0
  231. package/dist/bin/cli.js +1 -1
  232. package/dist/blueprint-manifest.d-BPyzoR0X.d.cts +4343 -0
  233. package/dist/blueprint-manifest.d-BPyzoR0X.d.ts +4343 -0
  234. package/dist/calendar.d-BEjLDagH.d.cts +353 -0
  235. package/dist/calendar.d-BEjLDagH.d.ts +353 -0
  236. package/dist/chunk-5OBMZHRL.cjs +14 -0
  237. package/dist/{chunk-CD4OX2U6.cjs → chunk-C7GDYBXX.cjs} +9 -9
  238. package/dist/{chunk-L66IX6GX.cjs → chunk-KMVJYNLB.cjs} +1 -1
  239. package/dist/chunk-KYCVV2XE.cjs +14 -0
  240. package/dist/chunk-RGO3LTAM.js +14 -0
  241. package/dist/{chunk-TSV242UN.js → chunk-WRD2XFHY.js} +9 -9
  242. package/dist/{chunk-LLZYRINH.js → chunk-Z4H2FZ2K.js} +1 -1
  243. package/dist/chunk-Z6HGUGXK.js +14 -0
  244. package/dist/configuration-hub.d-Cqaq2F-W.d.cts +478 -0
  245. package/dist/configuration-hub.d-Cqaq2F-W.d.ts +478 -0
  246. package/dist/consent.d-C2PROHhX.d.cts +265 -0
  247. package/dist/consent.d-C2PROHhX.d.ts +265 -0
  248. package/dist/customer-portal-5I7ZGQDU.cjs +7 -0
  249. package/dist/customer-portal-YL2YMPZL.js +7 -0
  250. package/dist/{customer-portal-runtime-PSM55KGU.js → customer-portal-runtime-N4NWQ67M.js} +1 -1
  251. package/dist/{customer-portal-runtime-DULJLR7F.cjs → customer-portal-runtime-OEXTSMSE.cjs} +2 -2
  252. package/dist/customer-portal.d-ChSEioI5.d.cts +17113 -0
  253. package/dist/customer-portal.d-ChSEioI5.d.ts +17113 -0
  254. package/dist/dashboard.d-CsGcA74I.d.cts +440 -0
  255. package/dist/dashboard.d-CsGcA74I.d.ts +440 -0
  256. package/dist/data-governance.d-BbZ466j5.d.cts +1178 -0
  257. package/dist/data-governance.d-BbZ466j5.d.ts +1178 -0
  258. package/dist/deduplication.d-D5GYddVu.d.cts +218 -0
  259. package/dist/deduplication.d-D5GYddVu.d.ts +218 -0
  260. package/dist/design.d-BRre8iLg.d.cts +2346 -0
  261. package/dist/design.d-BRre8iLg.d.ts +2346 -0
  262. package/dist/document.d-DN37pjdx.d.cts +648 -0
  263. package/dist/document.d-DN37pjdx.d.ts +648 -0
  264. package/dist/email-settings.d-B7Q_xT25.d.cts +2417 -0
  265. package/dist/email-settings.d-B7Q_xT25.d.ts +2417 -0
  266. package/dist/email-template.d-gtQkdaXM.d.cts +1188 -0
  267. package/dist/email-template.d-gtQkdaXM.d.ts +1188 -0
  268. package/dist/entity-SS36LQO6.cjs +7 -0
  269. package/dist/entity-Z4YWKDVG.js +7 -0
  270. package/dist/entity-mapping.d-DKSW3sfy.d.cts +1092 -0
  271. package/dist/entity-mapping.d-DKSW3sfy.d.ts +1092 -0
  272. package/dist/entity.d-fospShiN.d.cts +18544 -0
  273. package/dist/entity.d-fospShiN.d.ts +18544 -0
  274. package/dist/environments.d-BvqvN-PD.d.cts +382 -0
  275. package/dist/environments.d-BvqvN-PD.d.ts +382 -0
  276. package/dist/event-catalog.d-ENw6HO-w.d.cts +1511 -0
  277. package/dist/event-catalog.d-ENw6HO-w.d.ts +1511 -0
  278. package/dist/file.d-DcTJxjp7.d.cts +2992 -0
  279. package/dist/file.d-DcTJxjp7.d.ts +2992 -0
  280. package/dist/iban.d-BwdiGbxi.d.cts +70 -0
  281. package/dist/iban.d-BwdiGbxi.d.ts +70 -0
  282. package/dist/index.cjs +14 -14
  283. package/dist/index.d.cts +182 -0
  284. package/dist/index.d.ts +182 -12
  285. package/dist/index.js +4 -4
  286. package/dist/integration-toolkit.d-Ry-KC9ow.d.cts +5796 -0
  287. package/dist/integration-toolkit.d-Ry-KC9ow.d.ts +5796 -0
  288. package/dist/journey.d-ClXO0xK8.d.cts +1931 -0
  289. package/dist/journey.d-ClXO0xK8.d.ts +1931 -0
  290. package/dist/{js-yaml-UPZKYVRY.js → js-yaml-DLCVPJ7G.js} +17 -15
  291. package/dist/kanban.d-BHnSRCYW.d.cts +760 -0
  292. package/dist/kanban.d-BHnSRCYW.d.ts +760 -0
  293. package/dist/message.d-B5UuSqgw.d.cts +3811 -0
  294. package/dist/message.d-B5UuSqgw.d.ts +3811 -0
  295. package/dist/metering.d-DvtPv7wk.d.cts +1841 -0
  296. package/dist/metering.d-DvtPv7wk.d.ts +1841 -0
  297. package/dist/notes-K2IIFCX3.cjs +7 -0
  298. package/dist/notes-Q7JGS7O3.js +7 -0
  299. package/dist/notes.d-BcV_m5fe.d.cts +1068 -0
  300. package/dist/notes.d-BcV_m5fe.d.ts +1068 -0
  301. package/dist/notification.d-BfBL3lga.d.cts +1147 -0
  302. package/dist/notification.d-BfBL3lga.d.ts +1147 -0
  303. package/dist/organization.d-DqwnNxMg.d.cts +1271 -0
  304. package/dist/organization.d-DqwnNxMg.d.ts +1271 -0
  305. package/dist/partner-directory.d-BCIjHoGs.d.cts +2337 -0
  306. package/dist/partner-directory.d-BCIjHoGs.d.ts +2337 -0
  307. package/dist/permissions.d-l6AT8SYP.d.cts +1279 -0
  308. package/dist/permissions.d-l6AT8SYP.d.ts +1279 -0
  309. package/dist/{pricing-XAET4G7T.cjs → pricing-FODHQFCB.cjs} +1 -1
  310. package/dist/{pricing-G67CH3XH.js → pricing-XRIDVZFC.js} +1 -1
  311. package/dist/pricing-tier.d-Cg0jl6n_.d.cts +81 -0
  312. package/dist/pricing-tier.d-Cg0jl6n_.d.ts +81 -0
  313. package/dist/pricing.d-BHpMU4KU.d.cts +12255 -0
  314. package/dist/pricing.d-BHpMU4KU.d.ts +12255 -0
  315. package/dist/purpose.d-CbIYfTua.d.cts +372 -0
  316. package/dist/purpose.d-CbIYfTua.d.ts +372 -0
  317. package/dist/query.d-Cmp78IhZ.d.cts +2375 -0
  318. package/dist/query.d-Cmp78IhZ.d.ts +2375 -0
  319. package/dist/sandbox.d-BdbOFzDu.d.cts +465 -0
  320. package/dist/sandbox.d-BdbOFzDu.d.ts +465 -0
  321. package/dist/sharing.d-sOXq-gtz.d.cts +571 -0
  322. package/dist/sharing.d-sOXq-gtz.d.ts +571 -0
  323. package/dist/submission.d-BamwfhXw.d.cts +469 -0
  324. package/dist/submission.d-BamwfhXw.d.ts +469 -0
  325. package/dist/targeting.d-BNmcVsNS.d.cts +2057 -0
  326. package/dist/targeting.d-BNmcVsNS.d.ts +2057 -0
  327. package/dist/template-variables.d-Ble9TSBa.d.cts +1320 -0
  328. package/dist/template-variables.d-Ble9TSBa.d.ts +1320 -0
  329. package/dist/types-ChU9Acbv.d.cts +37 -0
  330. package/dist/types-ChU9Acbv.d.ts +37 -0
  331. package/dist/user.d-D18fe97W.d.cts +2270 -0
  332. package/dist/user.d-D18fe97W.d.ts +2270 -0
  333. package/dist/validation-rules.d-Db5c5zTf.d.cts +807 -0
  334. package/dist/validation-rules.d-Db5c5zTf.d.ts +807 -0
  335. package/dist/webhooks-NZ3TM3AY.cjs +7 -0
  336. package/dist/webhooks-XLBUXXCS.js +7 -0
  337. package/dist/{webhooks-runtime-EBM4M3SU.cjs → webhooks-runtime-QVAFNBDW.cjs} +2 -2
  338. package/dist/{webhooks-runtime-XCQYIGQK.js → webhooks-runtime-UYTPQQVG.js} +1 -1
  339. package/dist/webhooks.d-D79qib9f.d.cts +1366 -0
  340. package/dist/webhooks.d-D79qib9f.d.ts +1366 -0
  341. package/dist/workflow-definition.d-DOeb0KVV.d.cts +1922 -0
  342. package/dist/workflow-definition.d-DOeb0KVV.d.ts +1922 -0
  343. package/dist/workflow.d-CMSKt8oN.d.cts +3151 -0
  344. package/dist/workflow.d-CMSKt8oN.d.ts +3151 -0
  345. package/docs/app.md +244 -9
  346. package/docs/customer-portal.md +340 -113
  347. package/docs/entity.md +65 -0
  348. package/docs/notes.md +19 -12
  349. package/docs/pricing.md +3 -1
  350. package/docs/webhooks.md +49 -0
  351. package/package.json +1 -1
  352. package/dist/apis/_registry.d.ts +0 -8
  353. package/dist/app-5KSVSKDU.js +0 -7
  354. package/dist/app-PL3IOROO.cjs +0 -7
  355. package/dist/app-runtime-SSNHSBR7.cjs +0 -5
  356. package/dist/authorize.d.ts +0 -3
  357. package/dist/bin/cli.d.ts +0 -1
  358. package/dist/chunk-2MMSXUOL.cjs +0 -14
  359. package/dist/chunk-A7AAVJGM.js +0 -14
  360. package/dist/chunk-GVNT76UU.js +0 -14
  361. package/dist/chunk-HHMXS5NC.cjs +0 -14
  362. package/dist/client-factory.d.ts +0 -9
  363. package/dist/client-map.d.ts +0 -102
  364. package/dist/compact.d.ts +0 -22
  365. package/dist/customer-portal-5LMHNBMD.cjs +0 -7
  366. package/dist/customer-portal-RZACUF4N.js +0 -7
  367. package/dist/entity-H6ESUH3Y.js +0 -7
  368. package/dist/entity-ZVDKWQSF.cjs +0 -7
  369. package/dist/help.d.ts +0 -12
  370. package/dist/large-response.d.ts +0 -9
  371. package/dist/notes-3AO5GXIT.js +0 -7
  372. package/dist/notes-MPWOQC5J.cjs +0 -7
  373. package/dist/openapi.d.ts +0 -12
  374. package/dist/overrides.d.ts +0 -9
  375. package/dist/proxy.d.ts +0 -14
  376. package/dist/registry.d.ts +0 -19
  377. package/dist/retry.d.ts +0 -11
  378. package/dist/sdk.d.ts +0 -29
  379. package/dist/types.d.ts +0 -53
  380. package/dist/webhooks-H3RT33BF.cjs +0 -7
  381. package/dist/webhooks-RTOU3MS5.js +0 -7
package/dist/help.d.ts DELETED
@@ -1,12 +0,0 @@
1
- /**
2
- * Lazy-loaded help system — returns markdown docs for SDK APIs.
3
- * Each doc is loaded via dynamic import() so only the requested doc affects bundle size.
4
- */
5
- /**
6
- * Get help for a specific API or general SDK help.
7
- *
8
- * @example
9
- * await help() // general SDK docs
10
- * await help('entity') // entity API docs
11
- */
12
- export declare const help: (apiName?: string) => Promise<string>;
@@ -1,9 +0,0 @@
1
- import type { AxiosInstance } from 'axios';
2
- export type LargeResponseConfig = {
3
- /** Enable large response handling. Default: true */
4
- enabled?: boolean;
5
- };
6
- export declare const applyLargeResponseInterceptor: (params: {
7
- client: AxiosInstance;
8
- config: LargeResponseConfig;
9
- }) => void;
@@ -1,7 +0,0 @@
1
- import "./chunk-YPSWSI3M.js";
2
-
3
- // src/docs/notes.json
4
- var notes_default = '# Notes API\n\n- **Base URL:** `https://notes.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/notes](https://docs.epilot.io/api/notes)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.notes.createNote(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/notes\'\n\nconst notesClient = getClient()\nauthorize(notesClient, () => \'<token>\')\nconst { data } = await notesClient.createNote(...)\n```\n\n## Operations\n\n**Notes**\n- [`createNote`](#createnote)\n- [`getNote`](#getnote)\n- [`patchNote`](#patchnote)\n- [`updateNote`](#updatenote)\n- [`deleteNote`](#deletenote)\n- [`searchNotesByContext`](#searchnotesbycontext)\n- [`getNoteContexts`](#getnotecontexts)\n\n**Pinning**\n- [`pinNote`](#pinnote)\n\n**Reactions**\n- [`addNoteReaction`](#addnotereaction)\n- [`removeNoteReaction`](#removenotereaction)\n- [`toggleNoteReactions`](#togglenotereactions)\n\n**Schemas**\n- [`NotePostRequestBody`](#notepostrequestbody)\n- [`ContextType`](#contexttype)\n- [`NoteEntity`](#noteentity)\n- [`Entity`](#entity)\n- [`CreatedByType`](#createdbytype)\n- [`NoteGetRequestResponse`](#notegetrequestresponse)\n- [`NotePatchRequestBody`](#notepatchrequestbody)\n- [`NonHydratedNoteEntity`](#nonhydratednoteentity)\n- [`NoteEntityParent`](#noteentityparent)\n- [`NotePutRequestBody`](#noteputrequestbody)\n- [`NoteSearchByContextRequestBody`](#notesearchbycontextrequestbody)\n- [`NotesSearchRequestResponse`](#notessearchrequestresponse)\n- [`NoteContexts`](#notecontexts)\n- [`WorkflowExecution`](#workflowexecution)\n- [`ReactionRequest`](#reactionrequest)\n- [`ToggleReactionsRequest`](#togglereactionsrequest)\n\n### `createNote`\n\nCreates a new Note entry\n\n`POST /v1/note`\n\n```ts\nconst { data } = await client.createNote(\n null,\n {\n _tags: [\'string\'],\n type: \'string\',\n entity_id: \'string\',\n parent_id: \'string\',\n contexts: [\n {\n type: \'workflow_execution\',\n id: \'string\'\n }\n ],\n additional_contexts: [\n {\n type: \'workflow_execution\',\n id: \'string\'\n }\n ],\n content: \'string\',\n attachments: [\'string\'],\n read_by: [\'string\']\n },\n)\n```\n\n---\n\n### `getNote`\n\nRetrieves a single Note entry based on it\'s Entity ID\n\n`GET /v1/note/{id}`\n\n```ts\nconst { data } = await client.getNote({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n hydrate: true,\n})\n```\n\n---\n\n### `patchNote`\n\nUpdates an existing Note entry\n\n`PATCH /v1/note/{id}`\n\n```ts\nconst { data } = await client.patchNote({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `updateNote`\n\nUpdates an existing Note entry\n\n`PUT /v1/note/{id}`\n\n```ts\nconst { data } = await client.updateNote(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n },\n {\n _id: \'string\',\n _org: \'string\',\n _schema: \'string\',\n _created_at: \'1970-01-01T00:00:00.000Z\',\n _updated_at: \'1970-01-01T00:00:00.000Z\',\n _created_by: \'string\',\n _tags: [\'string\'],\n _acl: {},\n _owners: [\n {\n org_id: \'string\',\n user_id: \'string\'\n }\n ],\n type: \'string\',\n context_entities: {\n $relation: [\n {\n entity_id: \'string\'\n }\n ]\n },\n parent: {\n $relation: [\n {\n entity_id: \'string\'\n }\n ]\n },\n attachments: {\n $relation: [\n {\n entity_id: \'string\'\n }\n ]\n },\n content: \'string\',\n contexts: [\n {\n type: \'workflow_execution\',\n id: \'string\'\n }\n ],\n pinned_at: \'1970-01-01T00:00:00.000Z\',\n created_by: {\n type: \'user\',\n user_id: \'string\',\n display_name: \'string\',\n org_id: \'string\',\n email: \'string\',\n phone: \'string\'\n },\n read_by: [\'string\'],\n reactions: {}\n },\n)\n```\n\n---\n\n### `deleteNote`\n\nDeletes a single Note entry based on it\'s Entity ID\n\n`DELETE /v1/note/{id}`\n\n```ts\nconst { data } = await client.deleteNote({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `searchNotesByContext`\n\nSearch for a paginated list of Notes based on one or more contexts\n\n`POST /v1/notes:search`\n\n```ts\nconst { data } = await client.searchNotesByContext(\n null,\n {\n contexts: [\n {\n type: \'workflow_execution\',\n id: \'string\'\n }\n ],\n from: 0,\n size: 10\n },\n)\n```\n\n---\n\n### `pinNote`\n\nPins a single Note entry based on it\'s Entity ID\n\n`POST /v1/note/{id}/pin`\n\n```ts\nconst { data } = await client.pinNote({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `getNoteContexts`\n\nGets all the Entity and non-Entity records the Note is contextually attached to\n\n`GET /v1/note/{id}/context`\n\n```ts\nconst { data } = await client.getNoteContexts({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "type": "workflow_execution",\n "context": {\n "_id": "string",\n "_org": "string",\n "_schema": "string",\n "_created_at": "1970-01-01T00:00:00.000Z",\n "_updated_at": "1970-01-01T00:00:00.000Z",\n "_created_by": "string",\n "_tags": ["string"],\n "_acl": {},\n "_owners": [\n {\n "org_id": "string",\n "user_id": "string"\n }\n ],\n "type": "string"\n }\n }\n]\n```\n\n</details>\n\n---\n\n### `addNoteReaction`\n\nAdds an emoji reaction to a note\n\n`POST /v1/note/{id}/reaction`\n\n```ts\nconst { data } = await client.addNoteReaction(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n },\n {\n emoji: \'thumbs-up\'\n },\n)\n```\n\n---\n\n### `removeNoteReaction`\n\nRemoves an emoji reaction from a note\n\n`DELETE /v1/note/{id}/reaction/{emoji_shortcode}`\n\n```ts\nconst { data } = await client.removeNoteReaction({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n emoji_shortcode: \'example\',\n})\n```\n\n---\n\n### `toggleNoteReactions`\n\nToggles multiple emoji reactions on a note. If a user has already reacted with an emoji, it removes the reaction. If a user hasn\'t reacted with an emoji, it adds the reaction.\n\n`POST /v1/note/{id}/reactions/toggle`\n\n```ts\nconst { data } = await client.toggleNoteReactions(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n },\n {\n emojis: [\'thumbs-up\', \'heart\']\n },\n)\n```\n\n---\n\n## Schemas\n\n### `NotePostRequestBody`\n\n```ts\ntype NotePostRequestBody = {\n _tags?: string[]\n type?: string\n entity_id?: string\n parent_id?: string\n contexts?: Array<{\n type: "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n id: string\n }>\n additional_contexts?: Array<{\n type: "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n id: string\n }>\n content?: string\n attachments?: string[]\n read_by?: string[]\n}\n```\n\n### `ContextType`\n\n```ts\ntype ContextType = "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n```\n\n### `NoteEntity`\n\nA note Entity object cotaining Entity metadata and content. Relational attributes are hydrated in place.\n\n```ts\ntype NoteEntity = {\n _id: string\n _org?: string\n _schema?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _created_by?: string | number\n _tags?: string[]\n _acl?: Record<string, string[]>\n _owners?: Array<{\n org_id: string\n user_id: string\n }>\n type?: string\n}\n```\n\n### `Entity`\n\nBase Entity schema\n\n```ts\ntype Entity = {\n _id: string\n _org?: string\n _schema?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _created_by?: string | number\n _tags?: string[]\n _acl?: Record<string, string[]>\n _owners?: Array<{\n org_id: string\n user_id: string\n }>\n type?: string\n}\n```\n\n### `CreatedByType`\n\n```ts\ntype CreatedByType = "user" | "group"\n```\n\n### `NoteGetRequestResponse`\n\n```ts\ntype NoteGetRequestResponse = {\n _id: string\n _org?: string\n _schema?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _created_by?: string | number\n _tags?: string[]\n _acl?: Record<string, string[]>\n _owners?: Array<{\n org_id: string\n user_id: string\n }>\n type?: string\n}\n```\n\n### `NotePatchRequestBody`\n\n```ts\ntype NotePatchRequestBody = {\n _tags?: string[]\n type?: string\n attachments?: {\n $relation?: Array<{\n entity_id: { ... }\n }>\n }\n comments?: Array<{\n _id: string\n _org?: string\n _schema?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _created_by?: string | number\n _tags?: string[]\n _acl?: Record<string, string[]>\n _owners?: Array<{\n org_id: { ... }\n user_id: { ... }\n }>\n type?: string\n }>\n content?: string\n contexts?: Array<{\n type: "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n id: string\n }>\n pinned_at?: string // date-time\n created_by?: {\n type: "user" | "group"\n user_id?: string\n display_name?: string\n org_id?: string\n email?: string\n phone?: string\n }\n read_by?: string[]\n reactions?: Record<string, string[]>\n}\n```\n\n### `NonHydratedNoteEntity`\n\nA note Entity object cotaining Entity metadata and content. Relational attributes are not hydrated in place.\n\n```ts\ntype NonHydratedNoteEntity = {\n _id: string\n _org?: string\n _schema?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _created_by?: string | number\n _tags?: string[]\n _acl?: Record<string, string[]>\n _owners?: Array<{\n org_id: string\n user_id: string\n }>\n type?: string\n}\n```\n\n### `NoteEntityParent`\n\nThe Note\'s parent Note\n\n```ts\ntype NoteEntityParent = {\n $relation?: Array<{\n entity_id: string\n }>\n}\n```\n\n### `NotePutRequestBody`\n\n```ts\ntype NotePutRequestBody = {\n _id?: string\n _org?: string\n _schema?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _created_by?: string | number\n _tags?: string[]\n _acl?: Record<string, string[]>\n _owners?: Array<{\n org_id: string\n user_id: string\n }>\n type?: string\n context_entities?: {\n $relation: Array<{\n entity_id: { ... }\n }>\n }\n parent?: {\n $relation?: Array<{\n entity_id: { ... }\n }>\n }\n attachments?: {\n $relation?: Array<{\n entity_id: { ... }\n }>\n }\n content?: string\n contexts?: Array<{\n type: "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n id: string\n }>\n pinned_at?: string // date-time\n created_by?: {\n type: "user" | "group"\n user_id?: string\n display_name?: string\n org_id?: string\n email?: string\n phone?: string\n }\n read_by?: string[]\n reactions?: Record<string, string[]>\n}\n```\n\n### `NoteSearchByContextRequestBody`\n\n```ts\ntype NoteSearchByContextRequestBody = {\n contexts: Array<{\n type: "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n id: string\n }>\n from?: number\n size?: number\n}\n```\n\n### `NotesSearchRequestResponse`\n\n```ts\ntype NotesSearchRequestResponse = {\n hits?: number\n results: Array<{\n _id: string\n _org?: string\n _schema?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _created_by?: string | number\n _tags?: string[]\n _acl?: Record<string, string[]>\n _owners?: Array<{\n org_id: { ... }\n user_id: { ... }\n }>\n type?: string\n }>\n}\n```\n\n### `NoteContexts`\n\nList of resolved Entity and non-Entity contexts attached to a given Note.\n\n```ts\ntype NoteContexts = {\n type: "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n context: {\n _id: string\n _org?: string\n _schema?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _created_by?: string | number\n _tags?: string[]\n _acl?: Record<string, string[]>\n _owners?: Array<{\n org_id: { ... }\n user_id: { ... }\n }>\n type?: string\n } | {\n id: string\n definitionId: string\n orgId: string\n name: string\n }\n}\n```\n\n### `WorkflowExecution`\n\nBase metadata for a Workflow Execution. This is a lightweight representation of a Workflow Execution, and does not contain all it\'s data\n\n```ts\ntype WorkflowExecution = {\n id: string\n definitionId: string\n orgId: string\n name: string\n}\n```\n\n### `ReactionRequest`\n\n```ts\ntype ReactionRequest = {\n emoji: string\n}\n```\n\n### `ToggleReactionsRequest`\n\n```ts\ntype ToggleReactionsRequest = {\n emojis: string[]\n}\n```\n';
5
- export {
6
- notes_default as default
7
- };
@@ -1,7 +0,0 @@
1
- "use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
2
-
3
- // src/docs/notes.json
4
- var notes_default = '# Notes API\n\n- **Base URL:** `https://notes.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/notes](https://docs.epilot.io/api/notes)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.notes.createNote(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/notes\'\n\nconst notesClient = getClient()\nauthorize(notesClient, () => \'<token>\')\nconst { data } = await notesClient.createNote(...)\n```\n\n## Operations\n\n**Notes**\n- [`createNote`](#createnote)\n- [`getNote`](#getnote)\n- [`patchNote`](#patchnote)\n- [`updateNote`](#updatenote)\n- [`deleteNote`](#deletenote)\n- [`searchNotesByContext`](#searchnotesbycontext)\n- [`getNoteContexts`](#getnotecontexts)\n\n**Pinning**\n- [`pinNote`](#pinnote)\n\n**Reactions**\n- [`addNoteReaction`](#addnotereaction)\n- [`removeNoteReaction`](#removenotereaction)\n- [`toggleNoteReactions`](#togglenotereactions)\n\n**Schemas**\n- [`NotePostRequestBody`](#notepostrequestbody)\n- [`ContextType`](#contexttype)\n- [`NoteEntity`](#noteentity)\n- [`Entity`](#entity)\n- [`CreatedByType`](#createdbytype)\n- [`NoteGetRequestResponse`](#notegetrequestresponse)\n- [`NotePatchRequestBody`](#notepatchrequestbody)\n- [`NonHydratedNoteEntity`](#nonhydratednoteentity)\n- [`NoteEntityParent`](#noteentityparent)\n- [`NotePutRequestBody`](#noteputrequestbody)\n- [`NoteSearchByContextRequestBody`](#notesearchbycontextrequestbody)\n- [`NotesSearchRequestResponse`](#notessearchrequestresponse)\n- [`NoteContexts`](#notecontexts)\n- [`WorkflowExecution`](#workflowexecution)\n- [`ReactionRequest`](#reactionrequest)\n- [`ToggleReactionsRequest`](#togglereactionsrequest)\n\n### `createNote`\n\nCreates a new Note entry\n\n`POST /v1/note`\n\n```ts\nconst { data } = await client.createNote(\n null,\n {\n _tags: [\'string\'],\n type: \'string\',\n entity_id: \'string\',\n parent_id: \'string\',\n contexts: [\n {\n type: \'workflow_execution\',\n id: \'string\'\n }\n ],\n additional_contexts: [\n {\n type: \'workflow_execution\',\n id: \'string\'\n }\n ],\n content: \'string\',\n attachments: [\'string\'],\n read_by: [\'string\']\n },\n)\n```\n\n---\n\n### `getNote`\n\nRetrieves a single Note entry based on it\'s Entity ID\n\n`GET /v1/note/{id}`\n\n```ts\nconst { data } = await client.getNote({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n hydrate: true,\n})\n```\n\n---\n\n### `patchNote`\n\nUpdates an existing Note entry\n\n`PATCH /v1/note/{id}`\n\n```ts\nconst { data } = await client.patchNote({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `updateNote`\n\nUpdates an existing Note entry\n\n`PUT /v1/note/{id}`\n\n```ts\nconst { data } = await client.updateNote(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n },\n {\n _id: \'string\',\n _org: \'string\',\n _schema: \'string\',\n _created_at: \'1970-01-01T00:00:00.000Z\',\n _updated_at: \'1970-01-01T00:00:00.000Z\',\n _created_by: \'string\',\n _tags: [\'string\'],\n _acl: {},\n _owners: [\n {\n org_id: \'string\',\n user_id: \'string\'\n }\n ],\n type: \'string\',\n context_entities: {\n $relation: [\n {\n entity_id: \'string\'\n }\n ]\n },\n parent: {\n $relation: [\n {\n entity_id: \'string\'\n }\n ]\n },\n attachments: {\n $relation: [\n {\n entity_id: \'string\'\n }\n ]\n },\n content: \'string\',\n contexts: [\n {\n type: \'workflow_execution\',\n id: \'string\'\n }\n ],\n pinned_at: \'1970-01-01T00:00:00.000Z\',\n created_by: {\n type: \'user\',\n user_id: \'string\',\n display_name: \'string\',\n org_id: \'string\',\n email: \'string\',\n phone: \'string\'\n },\n read_by: [\'string\'],\n reactions: {}\n },\n)\n```\n\n---\n\n### `deleteNote`\n\nDeletes a single Note entry based on it\'s Entity ID\n\n`DELETE /v1/note/{id}`\n\n```ts\nconst { data } = await client.deleteNote({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `searchNotesByContext`\n\nSearch for a paginated list of Notes based on one or more contexts\n\n`POST /v1/notes:search`\n\n```ts\nconst { data } = await client.searchNotesByContext(\n null,\n {\n contexts: [\n {\n type: \'workflow_execution\',\n id: \'string\'\n }\n ],\n from: 0,\n size: 10\n },\n)\n```\n\n---\n\n### `pinNote`\n\nPins a single Note entry based on it\'s Entity ID\n\n`POST /v1/note/{id}/pin`\n\n```ts\nconst { data } = await client.pinNote({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `getNoteContexts`\n\nGets all the Entity and non-Entity records the Note is contextually attached to\n\n`GET /v1/note/{id}/context`\n\n```ts\nconst { data } = await client.getNoteContexts({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "type": "workflow_execution",\n "context": {\n "_id": "string",\n "_org": "string",\n "_schema": "string",\n "_created_at": "1970-01-01T00:00:00.000Z",\n "_updated_at": "1970-01-01T00:00:00.000Z",\n "_created_by": "string",\n "_tags": ["string"],\n "_acl": {},\n "_owners": [\n {\n "org_id": "string",\n "user_id": "string"\n }\n ],\n "type": "string"\n }\n }\n]\n```\n\n</details>\n\n---\n\n### `addNoteReaction`\n\nAdds an emoji reaction to a note\n\n`POST /v1/note/{id}/reaction`\n\n```ts\nconst { data } = await client.addNoteReaction(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n },\n {\n emoji: \'thumbs-up\'\n },\n)\n```\n\n---\n\n### `removeNoteReaction`\n\nRemoves an emoji reaction from a note\n\n`DELETE /v1/note/{id}/reaction/{emoji_shortcode}`\n\n```ts\nconst { data } = await client.removeNoteReaction({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n emoji_shortcode: \'example\',\n})\n```\n\n---\n\n### `toggleNoteReactions`\n\nToggles multiple emoji reactions on a note. If a user has already reacted with an emoji, it removes the reaction. If a user hasn\'t reacted with an emoji, it adds the reaction.\n\n`POST /v1/note/{id}/reactions/toggle`\n\n```ts\nconst { data } = await client.toggleNoteReactions(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n },\n {\n emojis: [\'thumbs-up\', \'heart\']\n },\n)\n```\n\n---\n\n## Schemas\n\n### `NotePostRequestBody`\n\n```ts\ntype NotePostRequestBody = {\n _tags?: string[]\n type?: string\n entity_id?: string\n parent_id?: string\n contexts?: Array<{\n type: "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n id: string\n }>\n additional_contexts?: Array<{\n type: "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n id: string\n }>\n content?: string\n attachments?: string[]\n read_by?: string[]\n}\n```\n\n### `ContextType`\n\n```ts\ntype ContextType = "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n```\n\n### `NoteEntity`\n\nA note Entity object cotaining Entity metadata and content. Relational attributes are hydrated in place.\n\n```ts\ntype NoteEntity = {\n _id: string\n _org?: string\n _schema?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _created_by?: string | number\n _tags?: string[]\n _acl?: Record<string, string[]>\n _owners?: Array<{\n org_id: string\n user_id: string\n }>\n type?: string\n}\n```\n\n### `Entity`\n\nBase Entity schema\n\n```ts\ntype Entity = {\n _id: string\n _org?: string\n _schema?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _created_by?: string | number\n _tags?: string[]\n _acl?: Record<string, string[]>\n _owners?: Array<{\n org_id: string\n user_id: string\n }>\n type?: string\n}\n```\n\n### `CreatedByType`\n\n```ts\ntype CreatedByType = "user" | "group"\n```\n\n### `NoteGetRequestResponse`\n\n```ts\ntype NoteGetRequestResponse = {\n _id: string\n _org?: string\n _schema?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _created_by?: string | number\n _tags?: string[]\n _acl?: Record<string, string[]>\n _owners?: Array<{\n org_id: string\n user_id: string\n }>\n type?: string\n}\n```\n\n### `NotePatchRequestBody`\n\n```ts\ntype NotePatchRequestBody = {\n _tags?: string[]\n type?: string\n attachments?: {\n $relation?: Array<{\n entity_id: { ... }\n }>\n }\n comments?: Array<{\n _id: string\n _org?: string\n _schema?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _created_by?: string | number\n _tags?: string[]\n _acl?: Record<string, string[]>\n _owners?: Array<{\n org_id: { ... }\n user_id: { ... }\n }>\n type?: string\n }>\n content?: string\n contexts?: Array<{\n type: "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n id: string\n }>\n pinned_at?: string // date-time\n created_by?: {\n type: "user" | "group"\n user_id?: string\n display_name?: string\n org_id?: string\n email?: string\n phone?: string\n }\n read_by?: string[]\n reactions?: Record<string, string[]>\n}\n```\n\n### `NonHydratedNoteEntity`\n\nA note Entity object cotaining Entity metadata and content. Relational attributes are not hydrated in place.\n\n```ts\ntype NonHydratedNoteEntity = {\n _id: string\n _org?: string\n _schema?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _created_by?: string | number\n _tags?: string[]\n _acl?: Record<string, string[]>\n _owners?: Array<{\n org_id: string\n user_id: string\n }>\n type?: string\n}\n```\n\n### `NoteEntityParent`\n\nThe Note\'s parent Note\n\n```ts\ntype NoteEntityParent = {\n $relation?: Array<{\n entity_id: string\n }>\n}\n```\n\n### `NotePutRequestBody`\n\n```ts\ntype NotePutRequestBody = {\n _id?: string\n _org?: string\n _schema?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _created_by?: string | number\n _tags?: string[]\n _acl?: Record<string, string[]>\n _owners?: Array<{\n org_id: string\n user_id: string\n }>\n type?: string\n context_entities?: {\n $relation: Array<{\n entity_id: { ... }\n }>\n }\n parent?: {\n $relation?: Array<{\n entity_id: { ... }\n }>\n }\n attachments?: {\n $relation?: Array<{\n entity_id: { ... }\n }>\n }\n content?: string\n contexts?: Array<{\n type: "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n id: string\n }>\n pinned_at?: string // date-time\n created_by?: {\n type: "user" | "group"\n user_id?: string\n display_name?: string\n org_id?: string\n email?: string\n phone?: string\n }\n read_by?: string[]\n reactions?: Record<string, string[]>\n}\n```\n\n### `NoteSearchByContextRequestBody`\n\n```ts\ntype NoteSearchByContextRequestBody = {\n contexts: Array<{\n type: "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n id: string\n }>\n from?: number\n size?: number\n}\n```\n\n### `NotesSearchRequestResponse`\n\n```ts\ntype NotesSearchRequestResponse = {\n hits?: number\n results: Array<{\n _id: string\n _org?: string\n _schema?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _created_by?: string | number\n _tags?: string[]\n _acl?: Record<string, string[]>\n _owners?: Array<{\n org_id: { ... }\n user_id: { ... }\n }>\n type?: string\n }>\n}\n```\n\n### `NoteContexts`\n\nList of resolved Entity and non-Entity contexts attached to a given Note.\n\n```ts\ntype NoteContexts = {\n type: "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n context: {\n _id: string\n _org?: string\n _schema?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _created_by?: string | number\n _tags?: string[]\n _acl?: Record<string, string[]>\n _owners?: Array<{\n org_id: { ... }\n user_id: { ... }\n }>\n type?: string\n } | {\n id: string\n definitionId: string\n orgId: string\n name: string\n }\n}\n```\n\n### `WorkflowExecution`\n\nBase metadata for a Workflow Execution. This is a lightweight representation of a Workflow Execution, and does not contain all it\'s data\n\n```ts\ntype WorkflowExecution = {\n id: string\n definitionId: string\n orgId: string\n name: string\n}\n```\n\n### `ReactionRequest`\n\n```ts\ntype ReactionRequest = {\n emoji: string\n}\n```\n\n### `ToggleReactionsRequest`\n\n```ts\ntype ToggleReactionsRequest = {\n emojis: string[]\n}\n```\n';
5
-
6
-
7
- exports.default = notes_default;
package/dist/openapi.d.ts DELETED
@@ -1,12 +0,0 @@
1
- /**
2
- * Lazy-loaded OpenAPI spec — returns the full OpenAPI JSON document for an API.
3
- * Each spec is loaded via dynamic import() so only the requested spec affects bundle size.
4
- */
5
- import type { Document } from 'openapi-client-axios';
6
- /**
7
- * Get the full OpenAPI specification for an API.
8
- *
9
- * @example
10
- * await openapi('entity') // full entity OpenAPI spec
11
- */
12
- export declare const openapi: (apiName: string) => Promise<Document>;
@@ -1,9 +0,0 @@
1
- import type { ApiEntry } from './types';
2
- /**
3
- * Loads overrides from .epilot/sdk-overrides.json synchronously.
4
- * Only performs filesystem reads on first call - subsequent calls are no-ops.
5
- * Safe to call in browser environments (fs/path are dynamically required).
6
- */
7
- export declare const loadOverrides: (registry: Map<string, ApiEntry>, cwd?: string) => void;
8
- /** Reset override loading state (for testing) */
9
- export declare const _resetOverrides: () => void;
package/dist/proxy.d.ts DELETED
@@ -1,14 +0,0 @@
1
- import type { AxiosInstance } from 'axios';
2
- import type { ApiHandle } from './types';
3
- /**
4
- * Creates an ApiHandle — a proxy that exposes explicit getClient() / createClient()
5
- * and forwards any other property access as an operation call on the lazy singleton.
6
- *
7
- * help() and openapi() are attached to clients at creation time in client-factory.ts,
8
- * so they work regardless of how the client is obtained.
9
- */
10
- export declare const createApiHandle: <T extends AxiosInstance>(params: {
11
- resolveClient: () => T;
12
- createClient: () => T;
13
- apiName?: string;
14
- }) => ApiHandle<T>;
@@ -1,19 +0,0 @@
1
- import type { AxiosInstance } from 'axios';
2
- import type { Document } from 'openapi-client-axios';
3
- import type { ApiEntry, SDKState } from './types';
4
- export declare const createRegistry: () => Map<string, ApiEntry>;
5
- export declare const registerApi: (params: {
6
- registry: Map<string, ApiEntry>;
7
- name: string;
8
- loader: () => Document;
9
- }) => void;
10
- export declare const resolveClient: (params: {
11
- registry: Map<string, ApiEntry>;
12
- name: string;
13
- state: SDKState;
14
- }) => AxiosInstance;
15
- export declare const resetClient: (params: {
16
- registry: Map<string, ApiEntry>;
17
- name: string;
18
- }) => void;
19
- export declare const resetAllClients: (registry: Map<string, ApiEntry>) => void;
package/dist/retry.d.ts DELETED
@@ -1,11 +0,0 @@
1
- import type { AxiosInstance } from 'axios';
2
- export type RetryConfig = {
3
- /** Maximum number of retries for 429 responses. Set to 0 to disable. Default: 3 */
4
- maxRetries?: number;
5
- /** Default delay in ms when Retry-After header is missing. Default: 1000 */
6
- defaultDelayMs?: number;
7
- };
8
- export declare const applyRetryInterceptor: (params: {
9
- client: AxiosInstance;
10
- config: RetryConfig;
11
- }) => void;
package/dist/sdk.d.ts DELETED
@@ -1,29 +0,0 @@
1
- import type { AxiosInstance, AxiosResponse, InternalAxiosRequestConfig } from 'axios';
2
- import type { TokenArg } from './authorize';
3
- import type { SDKClientMap } from './client-map';
4
- import type { LargeResponseConfig } from './large-response';
5
- import type { RetryConfig } from './retry';
6
- import type { ApiHandle, HeadersConfig } from './types';
7
- export type InterceptorUse = {
8
- request: (fulfilled: (config: InternalAxiosRequestConfig) => InternalAxiosRequestConfig | Promise<InternalAxiosRequestConfig>, rejected?: (error: unknown) => unknown) => void;
9
- response: (fulfilled: (response: AxiosResponse) => AxiosResponse | Promise<AxiosResponse>, rejected?: (error: unknown) => unknown) => void;
10
- };
11
- export type EpilotSDK = {
12
- /** Set a Bearer token (static string or async function) for all clients */
13
- authorize: (token: TokenArg) => void;
14
- /** Set global default headers applied to all clients (e.g. x-epilot-org-id) */
15
- headers: (headers: HeadersConfig) => void;
16
- /** Register global axios interceptors applied to all clients */
17
- interceptors: InterceptorUse;
18
- /** Configure retry behavior for 429 Too Many Requests responses */
19
- retry: (config: RetryConfig) => void;
20
- /** Configure large response handling for S3-backed payloads */
21
- largeResponse: (config: LargeResponseConfig) => void;
22
- /** Get markdown docs. No args = general SDK help, with API name = API-specific docs */
23
- help: (apiName?: string) => Promise<string>;
24
- /** Get the full OpenAPI specification for an API (lazy-loaded) */
25
- openapi: (apiName: string) => Promise<import('openapi-client-axios').Document>;
26
- } & {
27
- [K in keyof SDKClientMap]: ApiHandle<SDKClientMap[K]>;
28
- } & Record<string, ApiHandle<AxiosInstance>>;
29
- export declare const createSDK: () => EpilotSDK;
package/dist/types.d.ts DELETED
@@ -1,53 +0,0 @@
1
- import type { AxiosInstance, AxiosResponse, InternalAxiosRequestConfig } from 'axios';
2
- import type { Document } from 'openapi-client-axios';
3
- import type { LargeResponseConfig } from './large-response';
4
- import type { RetryConfig } from './retry';
5
- export type ApiEntry = {
6
- loader: () => Document;
7
- instance: AxiosInstance | null;
8
- };
9
- export type RequestInterceptor = {
10
- type: 'request';
11
- fulfilled: (config: InternalAxiosRequestConfig) => InternalAxiosRequestConfig | Promise<InternalAxiosRequestConfig>;
12
- rejected?: (error: unknown) => unknown;
13
- };
14
- export type ResponseInterceptor = {
15
- type: 'response';
16
- fulfilled: (response: AxiosResponse) => AxiosResponse | Promise<AxiosResponse>;
17
- rejected?: (error: unknown) => unknown;
18
- };
19
- export type Interceptor = RequestInterceptor | ResponseInterceptor;
20
- export type SDKState = {
21
- token: string | null;
22
- tokenFn: (() => string | Promise<string>) | null;
23
- globalHeaders: Record<string, string>;
24
- interceptors: Interceptor[];
25
- retry: RetryConfig;
26
- largeResponse: LargeResponseConfig;
27
- };
28
- export type HeadersConfig = Record<string, string>;
29
- export type OverridesConfig = Record<string, string>;
30
- /**
31
- * A non-API extension mounted on the SDK.
32
- * Unlike ApiEntry (OpenAPI-based), extensions are plain objects
33
- * with arbitrary methods and properties (e.g. factory functions, utilities).
34
- */
35
- export type ExtensionEntry = {
36
- value: unknown;
37
- };
38
- /**
39
- * An API handle that provides:
40
- * - `getClient()` — cached singleton
41
- * - `createClient()` — fresh instance
42
- * - Any operation method (e.g. `.getEntity(...)`) — auto-resolved via lazy singleton
43
- */
44
- export type ApiHandle<T extends AxiosInstance = AxiosInstance> = {
45
- /** Get the cached singleton client instance (lazy-initialized on first call) */
46
- getClient: () => T;
47
- /** Create a fresh client instance (not cached) */
48
- createClient: () => T;
49
- /** Get the full OpenAPI specification document (lazy-loaded) */
50
- openapi: () => Promise<Document>;
51
- } & {
52
- [K in keyof T]: T[K];
53
- };
@@ -1,7 +0,0 @@
1
- "use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
2
-
3
- // src/docs/webhooks.json
4
- var webhooks_default = '# Webhooks\n\n- **Base URL:** `https://webhooks.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/webhooks](https://docs.epilot.io/api/webhooks)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.webhooks.getPublicKey(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/webhooks\'\n\nconst webhooksClient = getClient()\nauthorize(webhooksClient, () => \'<token>\')\nconst { data } = await webhooksClient.getPublicKey(...)\n```\n\n## Operations\n\n**webhooks**\n- [`getPublicKey`](#getpublickey)\n- [`getConfiguredEvents`](#getconfiguredevents)\n- [`getConfigs`](#getconfigs)\n- [`createConfig`](#createconfig)\n- [`getConfig`](#getconfig)\n- [`updateConfig`](#updateconfig)\n- [`deleteConfig`](#deleteconfig)\n- [`triggerWebhook`](#triggerwebhook)\n- [`batchReplayEvents`](#batchreplayevents)\n- [`getEventById`](#geteventbyid)\n- [`replayEvent`](#replayevent)\n- [`getWebhookExample`](#getwebhookexample)\n\n**Events**\n- [`getWebhookEventsV2`](#getwebhookeventsv2)\n\n**Schemas**\n- [`PublicKeyResponse`](#publickeyresponse)\n- [`SearchOptions`](#searchoptions)\n- [`EventListResponse`](#eventlistresponse)\n- [`HttpMethod`](#httpmethod)\n- [`AuthType`](#authtype)\n- [`Filter`](#filter)\n- [`WebhookCondition`](#webhookcondition)\n- [`WebhookConditionGroup`](#webhookconditiongroup)\n- [`Auth`](#auth)\n- [`BasicAuthConfig`](#basicauthconfig)\n- [`OAuthConfig`](#oauthconfig)\n- [`ApiKeyConfig`](#apikeyconfig)\n- [`WebhookConfig`](#webhookconfig)\n- [`EventConfigResp`](#eventconfigresp)\n- [`EventConfigEntry`](#eventconfigentry)\n- [`ErrorResp`](#errorresp)\n- [`TriggerWebhookResp`](#triggerwebhookresp)\n- [`PayloadConfiguration`](#payloadconfiguration)\n- [`CustomHeader`](#customheader)\n- [`CustomOAuthParameter`](#customoauthparameter)\n- [`Metadata`](#metadata)\n- [`ExecutionPayload`](#executionpayload)\n- [`WebhookEvent`](#webhookevent)\n- [`ExampleRequest`](#examplerequest)\n- [`ExampleResponse`](#exampleresponse)\n- [`BatchReplayRequest`](#batchreplayrequest)\n\n### `getPublicKey`\n\nReturns the platform-level Ed25519 public key used to verify\nasymmetric (v1a) webhook signatures. This endpoint is unauthenticated since the public key is not a secret, but the orgId parameter is requ\n\n`GET /v1/webhooks/.well-known/public-key`\n\n```ts\nconst { data } = await client.getPublicKey({\n orgId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "public_key": "-----BEGIN PUBLIC KEY-----\\nMCowBQYDK2VwAyEA...\\n-----END PUBLIC KEY-----\\n",\n "algorithm": "ed25519",\n "issuer": "epilot"\n}\n```\n\n</details>\n\n---\n\n### `getConfiguredEvents`\n\nRetrieve events that can trigger webhooks\n\n`GET /v1/webhooks/configured-events`\n\n```ts\nconst { data } = await client.getConfiguredEvents()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "eventName": "customer_request_created",\n "eventLabel": "Customer Request Created"\n }\n]\n```\n\n</details>\n\n---\n\n### `getConfigs`\n\nSearch Webhook Client Configs\n\n`GET /v1/webhooks/configs`\n\n```ts\nconst { data } = await client.getConfigs({\n eventName: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "eventName": "CustomerRequest_Created",\n "url": "https://my-partner-service.api.com",\n "httpMethod": "POST",\n "enabled": true,\n "auth": {\n "authType": "BASIC",\n "basicAuthConfig": {\n "username": "secretUsername",\n "password": "secret7825@!"\n }\n },\n "filter": {\n "keyToFilter": "customer_request.productId",\n "supportedValues": ["2324245", "5253642"]\n }\n }\n]\n```\n\n</details>\n\n---\n\n### `createConfig`\n\nCreate Webhook Client Config\n\n`POST /v1/webhooks/configs`\n\n```ts\nconst { data } = await client.createConfig(\n null,\n {\n eventName: \'CustomerRequest_Created\',\n url: \'https://my-partner-service.api.com\',\n httpMethod: \'POST\',\n enabled: true,\n auth: {\n authType: \'BASIC\',\n basicAuthConfig: {\n username: \'secretUsername\',\n password: \'secret7825@!\'\n }\n },\n filter: {\n keyToFilter: \'customer_request.productId\',\n supportedValues: [\'2324245\', \'5253642\']\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "eventName": "CustomerRequest_Created",\n "url": "https://my-partner-service.api.com",\n "httpMethod": "POST",\n "enabled": true,\n "auth": {\n "authType": "BASIC",\n "basicAuthConfig": {\n "username": "secretUsername",\n "password": "secret7825@!"\n }\n },\n "filter": {\n "keyToFilter": "customer_request.productId",\n "supportedValues": ["2324245", "5253642"]\n }\n}\n```\n\n</details>\n\n---\n\n### `getConfig`\n\nGet webhook config by id\n\n`GET /v1/webhooks/configs/{configId}`\n\n```ts\nconst { data } = await client.getConfig({\n configId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "eventName": "CustomerRequest_Created",\n "url": "https://my-partner-service.api.com",\n "httpMethod": "POST",\n "enabled": true,\n "auth": {\n "authType": "BASIC",\n "basicAuthConfig": {\n "username": "secretUsername",\n "password": "secret7825@!"\n }\n },\n "filter": {\n "keyToFilter": "customer_request.productId",\n "supportedValues": ["2324245", "5253642"]\n }\n}\n```\n\n</details>\n\n---\n\n### `updateConfig`\n\nUpdate Webhook Client Config\n\n`PUT /v1/webhooks/configs/{configId}`\n\n```ts\nconst { data } = await client.updateConfig(\n {\n configId: \'example\',\n },\n {\n eventName: \'CustomerRequest_Created\',\n url: \'https://my-partner-service.api.com\',\n httpMethod: \'POST\',\n enabled: true,\n auth: {\n authType: \'BASIC\',\n basicAuthConfig: {\n username: \'secretUsername\',\n password: \'secret7825@!\'\n }\n },\n filter: {\n keyToFilter: \'customer_request.productId\',\n supportedValues: [\'2324245\', \'5253642\']\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "eventName": "CustomerRequest_Created",\n "url": "https://my-partner-service.api.com",\n "httpMethod": "POST",\n "enabled": true,\n "auth": {\n "authType": "BASIC",\n "basicAuthConfig": {\n "username": "secretUsername",\n "password": "secret7825@!"\n }\n },\n "filter": {\n "keyToFilter": "customer_request.productId",\n "supportedValues": ["2324245", "5253642"]\n }\n}\n```\n\n</details>\n\n---\n\n### `deleteConfig`\n\nDelete Webhook Client Config\n\n`DELETE /v1/webhooks/configs/{configId}`\n\n```ts\nconst { data } = await client.deleteConfig({\n configId: \'example\',\n})\n```\n\n---\n\n### `triggerWebhook`\n\ntriggers a webhook event either async or sync\n\n`POST /v1/webhooks/configs/{configId}/trigger`\n\n```ts\nconst { data } = await client.triggerWebhook(\n {\n sync: true,\n configId: \'example\',\n },\n {\n metadata: {\n action: \'Manual triggered by user with id 123456\',\n origin: \'string\',\n creation_timestamp: \'string\',\n webhook_id: \'string\',\n webhook_name: \'string\',\n automation_name: \'string\',\n organization_id: \'string\',\n user_id: \'string\',\n correlation_id: \'string\',\n execution_id: \'string\',\n action_id: \'string\'\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "status_code": "string",\n "message": "string",\n "body": {},\n "code": "string",\n "status": "succeeded",\n "start_date": "string",\n "end_date": "string",\n "event_id": "string"\n}\n```\n\n</details>\n\n---\n\n### `batchReplayEvents`\n\nReplay a batch of webhook events\n\n`POST /v1/webhooks/configs/{configId}/events/replay-batch`\n\n```ts\nconst { data } = await client.batchReplayEvents(\n {\n configId: \'example\',\n },\n {\n eventIds: [\'2f1b7cf8-ff55-4359-966f-e56f39a52c94\', \'48c984bf-466b-470b-b743-d07cea168243\']\n },\n)\n```\n\n---\n\n### `getEventById`\n\nGet a webhook event by its id\n\n`GET /v1/webhooks/configs/{configId}/events/{eventId}`\n\n```ts\nconst { data } = await client.getEventById({\n configId: \'example\',\n eventId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "event_id": "string",\n "org_id": "string",\n "webhook_config_id": "string",\n "url": "string",\n "created_at": "2021-04-27T12:01:13.000Z",\n "event_name": "string",\n "http_response": {\n "status_code": 0,\n "message": "string",\n "body": {},\n "code": "string"\n },\n "metadata": {\n "action": "Manual triggered by user with id 123456",\n "origin": "string",\n "creation_timestamp": "string",\n "webhook_id": "string",\n "webhook_name": "string",\n "automation_name": "string",\n "organization_id": "string",\n "user_id": "string",\n "correlation_id": "string",\n "execution_id": "string",\n "action_id": "string"\n },\n "status": "succeeded",\n "http_method": "GET",\n "payload": "string"\n}\n```\n\n</details>\n\n---\n\n### `replayEvent`\n\nReplay a webhook event\n\n`POST /v1/webhooks/configs/{configId}/events/{eventId}/replay`\n\n```ts\nconst { data } = await client.replayEvent({\n configId: \'example\',\n eventId: \'example\',\n})\n```\n\n---\n\n### `getWebhookExample`\n\nGenerate an example payload for a webhook configuration based on trigger type\n\n`POST /v1/webhooks/configs/{configId}/example`\n\n```ts\nconst { data } = await client.getWebhookExample(\n {\n configId: \'example\',\n },\n {\n automation_id: \'automation_123\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "metadata": {\n "action": "Manual triggered by user with id 123456",\n "origin": "string",\n "creation_timestamp": "string",\n "webhook_id": "string",\n "webhook_name": "string",\n "automation_name": "string",\n "organization_id": "string",\n "user_id": "string",\n "correlation_id": "string",\n "execution_id": "string",\n "action_id": "string"\n },\n "entity": {},\n "relations": [\n {}\n ]\n}\n```\n\n</details>\n\n---\n\n### `getWebhookEventsV2`\n\nList webhook events and filter them by status, timestamp, etc.\n\n`POST /v2/webhooks/configs/{configId}/events`\n\n```ts\nconst { data } = await client.getWebhookEventsV2(\n {\n configId: \'example\',\n },\n {\n limit: 25,\n cursor: {\n created_at: \'2025-10-31T12:34:56Z\',\n event_id: \'evt_1234567890abcdef\'\n },\n timestamp: {\n from: \'2025-10-01T00:00:00Z\',\n to: \'2025-10-31T23:59:59Z\'\n },\n event_id: \'evt_1234567890abcdef\',\n status: \'succeeded\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "data": [\n {\n "event_id": "string",\n "org_id": "string",\n "webhook_config_id": "string",\n "url": "string",\n "created_at": "2021-04-27T12:01:13.000Z",\n "event_name": "string",\n "http_response": {\n "status_code": 0,\n "message": "string",\n "body": {},\n "code": "string"\n },\n "metadata": {\n "action": "Manual triggered by user with id 123456",\n "origin": "string",\n "creation_timestamp": "string",\n "webhook_id": "string",\n "webhook_name": "string",\n "automation_name": "string",\n "organization_id": "string",\n "user_id": "string",\n "correlation_id": "string",\n "execution_id": "string",\n "action_id": "string"\n },\n "status": "succeeded",\n "http_method": "GET",\n "payload": "string"\n }\n ],\n "next_cursor": {\n "created_at": "2025-10-31T12:34:56Z",\n "event_id": "evt_1234567890abcdef"\n },\n "has_more": true\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `PublicKeyResponse`\n\n```ts\ntype PublicKeyResponse = {\n public_key: string\n algorithm: string\n issuer?: string\n}\n```\n\n### `SearchOptions`\n\n```ts\ntype SearchOptions = {\n limit?: number\n cursor?: {\n created_at?: string // date-time\n event_id?: string\n }\n timestamp?: {\n from?: string // date-time\n to?: string // date-time\n }\n event_id?: string\n status?: "succeeded" | "failed" | "skipped"\n}\n```\n\n### `EventListResponse`\n\n```ts\ntype EventListResponse = {\n data?: Array<{\n event_id: string\n org_id: string\n webhook_config_id: string\n url?: string\n created_at?: string\n event_name?: string\n http_response?: {\n status_code?: { ... }\n message?: { ... }\n body?: { ... }\n code?: { ... }\n }\n metadata?: {\n action?: { ... }\n origin?: { ... }\n creation_timestamp?: { ... }\n webhook_id?: { ... }\n webhook_name?: { ... }\n automation_name?: { ... }\n organization_id: { ... }\n user_id?: { ... }\n correlation_id?: { ... }\n execution_id?: { ... }\n action_id?: { ... }\n }\n status?: "succeeded" | "failed" | "in_progress" | "skipped"\n http_method?: "GET" | "POST" | "PUT"\n payload?: string\n }>\n next_cursor?: {\n created_at?: string // date-time\n event_id?: string\n }\n has_more?: boolean\n}\n```\n\n### `HttpMethod`\n\n```ts\ntype HttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD"\n```\n\n### `AuthType`\n\n```ts\ntype AuthType = "BASIC" | "OAUTH_CLIENT_CREDENTIALS" | "API_KEY" | "NONE"\n```\n\n### `Filter`\n\n```ts\ntype Filter = {\n keyToFilter: string\n supportedValues: string[]\n}\n```\n\n### `WebhookCondition`\n\nA condition that must be met for the webhook to fire.\n\n```ts\ntype WebhookCondition = {\n field: string\n 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"\n values?: string[]\n field_type?: "string" | "number" | "boolean" | "date" | "datetime"\n is_array_field?: boolean\n repeatable_item_op?: boolean\n}\n```\n\n### `WebhookConditionGroup`\n\nA group of conditions with a logical operator. Multiple conditions are AND-ed by default.\n\n```ts\ntype WebhookConditionGroup = {\n conditions?: Array<{\n field: string\n 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"\n values?: string[]\n field_type?: "string" | "number" | "boolean" | "date" | "datetime"\n is_array_field?: boolean\n repeatable_item_op?: boolean\n }>\n logical_operator?: "AND" | "OR"\n}\n```\n\n### `Auth`\n\n```ts\ntype Auth = {\n authType: "BASIC" | "OAUTH_CLIENT_CREDENTIALS" | "API_KEY" | "NONE"\n basicAuthConfig?: {\n username: string\n password?: string\n passwordIsEnvVar?: boolean\n }\n oauthConfig?: {\n clientId: string\n clientSecret?: string\n clientSecretIsEnvVar?: boolean\n endpoint: string\n httpMethod: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD"\n customParameterList?: Array<{\n type: { ... }\n key: { ... }\n value: { ... }\n }>\n }\n apiKeyConfig?: {\n keyName: string\n keyValue?: string\n keyValueIsEnvVar?: boolean\n }\n}\n```\n\n### `BasicAuthConfig`\n\nTo be sent only if authType is BASIC\n\n```ts\ntype BasicAuthConfig = {\n username: string\n password?: string\n passwordIsEnvVar?: boolean\n}\n```\n\n### `OAuthConfig`\n\nTo be sent only if authType is OAUTH_CLIENT_CREDENTIALS\n\n```ts\ntype OAuthConfig = {\n clientId: string\n clientSecret?: string\n clientSecretIsEnvVar?: boolean\n endpoint: string\n httpMethod: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD"\n customParameterList?: Array<{\n type: "body" | "query" | "header"\n key: string\n value: string\n }>\n}\n```\n\n### `ApiKeyConfig`\n\nTo be sent only if authType is API_KEY\n\n```ts\ntype ApiKeyConfig = {\n keyName: string\n keyValue?: string\n keyValueIsEnvVar?: boolean\n}\n```\n\n### `WebhookConfig`\n\n```ts\ntype WebhookConfig = {\n id?: string\n name: string\n eventName: string\n url?: string\n creationTime?: string\n httpMethod?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD"\n enabled?: boolean\n auth?: {\n authType: "BASIC" | "OAUTH_CLIENT_CREDENTIALS" | "API_KEY" | "NONE"\n basicAuthConfig?: {\n username: { ... }\n password?: { ... }\n passwordIsEnvVar?: { ... }\n }\n oauthConfig?: {\n clientId: { ... }\n clientSecret?: { ... }\n clientSecretIsEnvVar?: { ... }\n endpoint: { ... }\n httpMethod: { ... }\n customParameterList?: { ... }\n }\n apiKeyConfig?: {\n keyName: { ... }\n keyValue?: { ... }\n keyValueIsEnvVar?: { ... }\n }\n }\n filter?: {\n keyToFilter: string\n supportedValues: string[]\n }\n payloadConfiguration?: {\n hydrate_entity?: boolean\n include_relations?: boolean\n include_activity?: boolean\n include_changed_attributes?: boolean\n custom_headers?: Record<string, string>\n }\n enableStaticIP?: boolean\n protected?: boolean\n secureProxy?: {\n integration_id: string // uuid\n use_case_slug: string\n }\n status?: "active" | "inactive" | "incomplete"\n jsonataExpression?: string\n filterConditions?: {\n conditions?: Array<{\n field: { ... }\n operation: { ... }\n values?: { ... }\n field_type?: { ... }\n is_array_field?: { ... }\n repeatable_item_op?: { ... }\n }>\n logical_operator?: "AND" | "OR"\n }\n _manifest?: string // uuid[]\n signingSecret?: string\n}\n```\n\n### `EventConfigResp`\n\n```ts\ntype EventConfigResp = Array<{\n eventName?: string\n eventLabel?: string\n}>\n```\n\n### `EventConfigEntry`\n\n```ts\ntype EventConfigEntry = {\n eventName?: string\n eventLabel?: string\n}\n```\n\n### `ErrorResp`\n\n```ts\ntype ErrorResp = {\n message?: string\n}\n```\n\n### `TriggerWebhookResp`\n\n```ts\ntype TriggerWebhookResp = {\n status_code?: string\n message?: string\n body?: object\n code?: string\n status?: "succeeded" | "failed"\n start_date?: string\n end_date?: string\n event_id: string\n}\n```\n\n### `PayloadConfiguration`\n\nConfiguration for the webhook payload\n\n```ts\ntype PayloadConfiguration = {\n hydrate_entity?: boolean\n include_relations?: boolean\n include_activity?: boolean\n include_changed_attributes?: boolean\n custom_headers?: Record<string, string>\n}\n```\n\n### `CustomHeader`\n\nObject representing custom headers as key-value pairs.\n\n```ts\ntype CustomHeader = Record<string, string>\n```\n\n### `CustomOAuthParameter`\n\nCustom key/value pair of either type body, query or header\n\n```ts\ntype CustomOAuthParameter = {\n type: "body" | "query" | "header"\n key: string\n value: string\n}\n```\n\n### `Metadata`\n\nContains the metadata about the configured event\n\n```ts\ntype Metadata = {\n action?: string\n origin?: string\n creation_timestamp?: string\n webhook_id?: string\n webhook_name?: string\n automation_name?: string\n organization_id: string\n user_id?: string\n correlation_id?: string\n execution_id?: string\n action_id?: string\n}\n```\n\n### `ExecutionPayload`\n\nPayload for triggering a webhook\n\n```ts\ntype ExecutionPayload = {\n metadata: {\n action?: string\n origin?: string\n creation_timestamp?: string\n webhook_id?: string\n webhook_name?: string\n automation_name?: string\n organization_id: string\n user_id?: string\n correlation_id?: string\n execution_id?: string\n action_id?: string\n }\n}\n```\n\n### `WebhookEvent`\n\n```ts\ntype WebhookEvent = {\n event_id: string\n org_id: string\n webhook_config_id: string\n url?: string\n created_at?: string\n event_name?: string\n http_response?: {\n status_code?: number\n message?: string\n body?: object\n code?: string\n }\n metadata?: {\n action?: string\n origin?: string\n creation_timestamp?: string\n webhook_id?: string\n webhook_name?: string\n automation_name?: string\n organization_id: string\n user_id?: string\n correlation_id?: string\n execution_id?: string\n action_id?: string\n }\n status?: "succeeded" | "failed" | "in_progress" | "skipped"\n http_method?: "GET" | "POST" | "PUT"\n payload?: string\n}\n```\n\n### `ExampleRequest`\n\n```ts\ntype ExampleRequest = {\n automation_id?: string\n}\n```\n\n### `ExampleResponse`\n\n```ts\ntype ExampleResponse = {\n metadata?: {\n action?: string\n origin?: string\n creation_timestamp?: string\n webhook_id?: string\n webhook_name?: string\n automation_name?: string\n organization_id: string\n user_id?: string\n correlation_id?: string\n execution_id?: string\n action_id?: string\n }\n entity?: Record<string, unknown>\n relations?: Record<string, unknown>[]\n}\n```\n\n### `BatchReplayRequest`\n\n```ts\ntype BatchReplayRequest = {\n eventIds: string[]\n}\n```\n';
5
-
6
-
7
- exports.default = webhooks_default;
@@ -1,7 +0,0 @@
1
- import "./chunk-YPSWSI3M.js";
2
-
3
- // src/docs/webhooks.json
4
- var webhooks_default = '# Webhooks\n\n- **Base URL:** `https://webhooks.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/webhooks](https://docs.epilot.io/api/webhooks)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.webhooks.getPublicKey(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/webhooks\'\n\nconst webhooksClient = getClient()\nauthorize(webhooksClient, () => \'<token>\')\nconst { data } = await webhooksClient.getPublicKey(...)\n```\n\n## Operations\n\n**webhooks**\n- [`getPublicKey`](#getpublickey)\n- [`getConfiguredEvents`](#getconfiguredevents)\n- [`getConfigs`](#getconfigs)\n- [`createConfig`](#createconfig)\n- [`getConfig`](#getconfig)\n- [`updateConfig`](#updateconfig)\n- [`deleteConfig`](#deleteconfig)\n- [`triggerWebhook`](#triggerwebhook)\n- [`batchReplayEvents`](#batchreplayevents)\n- [`getEventById`](#geteventbyid)\n- [`replayEvent`](#replayevent)\n- [`getWebhookExample`](#getwebhookexample)\n\n**Events**\n- [`getWebhookEventsV2`](#getwebhookeventsv2)\n\n**Schemas**\n- [`PublicKeyResponse`](#publickeyresponse)\n- [`SearchOptions`](#searchoptions)\n- [`EventListResponse`](#eventlistresponse)\n- [`HttpMethod`](#httpmethod)\n- [`AuthType`](#authtype)\n- [`Filter`](#filter)\n- [`WebhookCondition`](#webhookcondition)\n- [`WebhookConditionGroup`](#webhookconditiongroup)\n- [`Auth`](#auth)\n- [`BasicAuthConfig`](#basicauthconfig)\n- [`OAuthConfig`](#oauthconfig)\n- [`ApiKeyConfig`](#apikeyconfig)\n- [`WebhookConfig`](#webhookconfig)\n- [`EventConfigResp`](#eventconfigresp)\n- [`EventConfigEntry`](#eventconfigentry)\n- [`ErrorResp`](#errorresp)\n- [`TriggerWebhookResp`](#triggerwebhookresp)\n- [`PayloadConfiguration`](#payloadconfiguration)\n- [`CustomHeader`](#customheader)\n- [`CustomOAuthParameter`](#customoauthparameter)\n- [`Metadata`](#metadata)\n- [`ExecutionPayload`](#executionpayload)\n- [`WebhookEvent`](#webhookevent)\n- [`ExampleRequest`](#examplerequest)\n- [`ExampleResponse`](#exampleresponse)\n- [`BatchReplayRequest`](#batchreplayrequest)\n\n### `getPublicKey`\n\nReturns the platform-level Ed25519 public key used to verify\nasymmetric (v1a) webhook signatures. This endpoint is unauthenticated since the public key is not a secret, but the orgId parameter is requ\n\n`GET /v1/webhooks/.well-known/public-key`\n\n```ts\nconst { data } = await client.getPublicKey({\n orgId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "public_key": "-----BEGIN PUBLIC KEY-----\\nMCowBQYDK2VwAyEA...\\n-----END PUBLIC KEY-----\\n",\n "algorithm": "ed25519",\n "issuer": "epilot"\n}\n```\n\n</details>\n\n---\n\n### `getConfiguredEvents`\n\nRetrieve events that can trigger webhooks\n\n`GET /v1/webhooks/configured-events`\n\n```ts\nconst { data } = await client.getConfiguredEvents()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "eventName": "customer_request_created",\n "eventLabel": "Customer Request Created"\n }\n]\n```\n\n</details>\n\n---\n\n### `getConfigs`\n\nSearch Webhook Client Configs\n\n`GET /v1/webhooks/configs`\n\n```ts\nconst { data } = await client.getConfigs({\n eventName: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "eventName": "CustomerRequest_Created",\n "url": "https://my-partner-service.api.com",\n "httpMethod": "POST",\n "enabled": true,\n "auth": {\n "authType": "BASIC",\n "basicAuthConfig": {\n "username": "secretUsername",\n "password": "secret7825@!"\n }\n },\n "filter": {\n "keyToFilter": "customer_request.productId",\n "supportedValues": ["2324245", "5253642"]\n }\n }\n]\n```\n\n</details>\n\n---\n\n### `createConfig`\n\nCreate Webhook Client Config\n\n`POST /v1/webhooks/configs`\n\n```ts\nconst { data } = await client.createConfig(\n null,\n {\n eventName: \'CustomerRequest_Created\',\n url: \'https://my-partner-service.api.com\',\n httpMethod: \'POST\',\n enabled: true,\n auth: {\n authType: \'BASIC\',\n basicAuthConfig: {\n username: \'secretUsername\',\n password: \'secret7825@!\'\n }\n },\n filter: {\n keyToFilter: \'customer_request.productId\',\n supportedValues: [\'2324245\', \'5253642\']\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "eventName": "CustomerRequest_Created",\n "url": "https://my-partner-service.api.com",\n "httpMethod": "POST",\n "enabled": true,\n "auth": {\n "authType": "BASIC",\n "basicAuthConfig": {\n "username": "secretUsername",\n "password": "secret7825@!"\n }\n },\n "filter": {\n "keyToFilter": "customer_request.productId",\n "supportedValues": ["2324245", "5253642"]\n }\n}\n```\n\n</details>\n\n---\n\n### `getConfig`\n\nGet webhook config by id\n\n`GET /v1/webhooks/configs/{configId}`\n\n```ts\nconst { data } = await client.getConfig({\n configId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "eventName": "CustomerRequest_Created",\n "url": "https://my-partner-service.api.com",\n "httpMethod": "POST",\n "enabled": true,\n "auth": {\n "authType": "BASIC",\n "basicAuthConfig": {\n "username": "secretUsername",\n "password": "secret7825@!"\n }\n },\n "filter": {\n "keyToFilter": "customer_request.productId",\n "supportedValues": ["2324245", "5253642"]\n }\n}\n```\n\n</details>\n\n---\n\n### `updateConfig`\n\nUpdate Webhook Client Config\n\n`PUT /v1/webhooks/configs/{configId}`\n\n```ts\nconst { data } = await client.updateConfig(\n {\n configId: \'example\',\n },\n {\n eventName: \'CustomerRequest_Created\',\n url: \'https://my-partner-service.api.com\',\n httpMethod: \'POST\',\n enabled: true,\n auth: {\n authType: \'BASIC\',\n basicAuthConfig: {\n username: \'secretUsername\',\n password: \'secret7825@!\'\n }\n },\n filter: {\n keyToFilter: \'customer_request.productId\',\n supportedValues: [\'2324245\', \'5253642\']\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "eventName": "CustomerRequest_Created",\n "url": "https://my-partner-service.api.com",\n "httpMethod": "POST",\n "enabled": true,\n "auth": {\n "authType": "BASIC",\n "basicAuthConfig": {\n "username": "secretUsername",\n "password": "secret7825@!"\n }\n },\n "filter": {\n "keyToFilter": "customer_request.productId",\n "supportedValues": ["2324245", "5253642"]\n }\n}\n```\n\n</details>\n\n---\n\n### `deleteConfig`\n\nDelete Webhook Client Config\n\n`DELETE /v1/webhooks/configs/{configId}`\n\n```ts\nconst { data } = await client.deleteConfig({\n configId: \'example\',\n})\n```\n\n---\n\n### `triggerWebhook`\n\ntriggers a webhook event either async or sync\n\n`POST /v1/webhooks/configs/{configId}/trigger`\n\n```ts\nconst { data } = await client.triggerWebhook(\n {\n sync: true,\n configId: \'example\',\n },\n {\n metadata: {\n action: \'Manual triggered by user with id 123456\',\n origin: \'string\',\n creation_timestamp: \'string\',\n webhook_id: \'string\',\n webhook_name: \'string\',\n automation_name: \'string\',\n organization_id: \'string\',\n user_id: \'string\',\n correlation_id: \'string\',\n execution_id: \'string\',\n action_id: \'string\'\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "status_code": "string",\n "message": "string",\n "body": {},\n "code": "string",\n "status": "succeeded",\n "start_date": "string",\n "end_date": "string",\n "event_id": "string"\n}\n```\n\n</details>\n\n---\n\n### `batchReplayEvents`\n\nReplay a batch of webhook events\n\n`POST /v1/webhooks/configs/{configId}/events/replay-batch`\n\n```ts\nconst { data } = await client.batchReplayEvents(\n {\n configId: \'example\',\n },\n {\n eventIds: [\'2f1b7cf8-ff55-4359-966f-e56f39a52c94\', \'48c984bf-466b-470b-b743-d07cea168243\']\n },\n)\n```\n\n---\n\n### `getEventById`\n\nGet a webhook event by its id\n\n`GET /v1/webhooks/configs/{configId}/events/{eventId}`\n\n```ts\nconst { data } = await client.getEventById({\n configId: \'example\',\n eventId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "event_id": "string",\n "org_id": "string",\n "webhook_config_id": "string",\n "url": "string",\n "created_at": "2021-04-27T12:01:13.000Z",\n "event_name": "string",\n "http_response": {\n "status_code": 0,\n "message": "string",\n "body": {},\n "code": "string"\n },\n "metadata": {\n "action": "Manual triggered by user with id 123456",\n "origin": "string",\n "creation_timestamp": "string",\n "webhook_id": "string",\n "webhook_name": "string",\n "automation_name": "string",\n "organization_id": "string",\n "user_id": "string",\n "correlation_id": "string",\n "execution_id": "string",\n "action_id": "string"\n },\n "status": "succeeded",\n "http_method": "GET",\n "payload": "string"\n}\n```\n\n</details>\n\n---\n\n### `replayEvent`\n\nReplay a webhook event\n\n`POST /v1/webhooks/configs/{configId}/events/{eventId}/replay`\n\n```ts\nconst { data } = await client.replayEvent({\n configId: \'example\',\n eventId: \'example\',\n})\n```\n\n---\n\n### `getWebhookExample`\n\nGenerate an example payload for a webhook configuration based on trigger type\n\n`POST /v1/webhooks/configs/{configId}/example`\n\n```ts\nconst { data } = await client.getWebhookExample(\n {\n configId: \'example\',\n },\n {\n automation_id: \'automation_123\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "metadata": {\n "action": "Manual triggered by user with id 123456",\n "origin": "string",\n "creation_timestamp": "string",\n "webhook_id": "string",\n "webhook_name": "string",\n "automation_name": "string",\n "organization_id": "string",\n "user_id": "string",\n "correlation_id": "string",\n "execution_id": "string",\n "action_id": "string"\n },\n "entity": {},\n "relations": [\n {}\n ]\n}\n```\n\n</details>\n\n---\n\n### `getWebhookEventsV2`\n\nList webhook events and filter them by status, timestamp, etc.\n\n`POST /v2/webhooks/configs/{configId}/events`\n\n```ts\nconst { data } = await client.getWebhookEventsV2(\n {\n configId: \'example\',\n },\n {\n limit: 25,\n cursor: {\n created_at: \'2025-10-31T12:34:56Z\',\n event_id: \'evt_1234567890abcdef\'\n },\n timestamp: {\n from: \'2025-10-01T00:00:00Z\',\n to: \'2025-10-31T23:59:59Z\'\n },\n event_id: \'evt_1234567890abcdef\',\n status: \'succeeded\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "data": [\n {\n "event_id": "string",\n "org_id": "string",\n "webhook_config_id": "string",\n "url": "string",\n "created_at": "2021-04-27T12:01:13.000Z",\n "event_name": "string",\n "http_response": {\n "status_code": 0,\n "message": "string",\n "body": {},\n "code": "string"\n },\n "metadata": {\n "action": "Manual triggered by user with id 123456",\n "origin": "string",\n "creation_timestamp": "string",\n "webhook_id": "string",\n "webhook_name": "string",\n "automation_name": "string",\n "organization_id": "string",\n "user_id": "string",\n "correlation_id": "string",\n "execution_id": "string",\n "action_id": "string"\n },\n "status": "succeeded",\n "http_method": "GET",\n "payload": "string"\n }\n ],\n "next_cursor": {\n "created_at": "2025-10-31T12:34:56Z",\n "event_id": "evt_1234567890abcdef"\n },\n "has_more": true\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `PublicKeyResponse`\n\n```ts\ntype PublicKeyResponse = {\n public_key: string\n algorithm: string\n issuer?: string\n}\n```\n\n### `SearchOptions`\n\n```ts\ntype SearchOptions = {\n limit?: number\n cursor?: {\n created_at?: string // date-time\n event_id?: string\n }\n timestamp?: {\n from?: string // date-time\n to?: string // date-time\n }\n event_id?: string\n status?: "succeeded" | "failed" | "skipped"\n}\n```\n\n### `EventListResponse`\n\n```ts\ntype EventListResponse = {\n data?: Array<{\n event_id: string\n org_id: string\n webhook_config_id: string\n url?: string\n created_at?: string\n event_name?: string\n http_response?: {\n status_code?: { ... }\n message?: { ... }\n body?: { ... }\n code?: { ... }\n }\n metadata?: {\n action?: { ... }\n origin?: { ... }\n creation_timestamp?: { ... }\n webhook_id?: { ... }\n webhook_name?: { ... }\n automation_name?: { ... }\n organization_id: { ... }\n user_id?: { ... }\n correlation_id?: { ... }\n execution_id?: { ... }\n action_id?: { ... }\n }\n status?: "succeeded" | "failed" | "in_progress" | "skipped"\n http_method?: "GET" | "POST" | "PUT"\n payload?: string\n }>\n next_cursor?: {\n created_at?: string // date-time\n event_id?: string\n }\n has_more?: boolean\n}\n```\n\n### `HttpMethod`\n\n```ts\ntype HttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD"\n```\n\n### `AuthType`\n\n```ts\ntype AuthType = "BASIC" | "OAUTH_CLIENT_CREDENTIALS" | "API_KEY" | "NONE"\n```\n\n### `Filter`\n\n```ts\ntype Filter = {\n keyToFilter: string\n supportedValues: string[]\n}\n```\n\n### `WebhookCondition`\n\nA condition that must be met for the webhook to fire.\n\n```ts\ntype WebhookCondition = {\n field: string\n 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"\n values?: string[]\n field_type?: "string" | "number" | "boolean" | "date" | "datetime"\n is_array_field?: boolean\n repeatable_item_op?: boolean\n}\n```\n\n### `WebhookConditionGroup`\n\nA group of conditions with a logical operator. Multiple conditions are AND-ed by default.\n\n```ts\ntype WebhookConditionGroup = {\n conditions?: Array<{\n field: string\n 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"\n values?: string[]\n field_type?: "string" | "number" | "boolean" | "date" | "datetime"\n is_array_field?: boolean\n repeatable_item_op?: boolean\n }>\n logical_operator?: "AND" | "OR"\n}\n```\n\n### `Auth`\n\n```ts\ntype Auth = {\n authType: "BASIC" | "OAUTH_CLIENT_CREDENTIALS" | "API_KEY" | "NONE"\n basicAuthConfig?: {\n username: string\n password?: string\n passwordIsEnvVar?: boolean\n }\n oauthConfig?: {\n clientId: string\n clientSecret?: string\n clientSecretIsEnvVar?: boolean\n endpoint: string\n httpMethod: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD"\n customParameterList?: Array<{\n type: { ... }\n key: { ... }\n value: { ... }\n }>\n }\n apiKeyConfig?: {\n keyName: string\n keyValue?: string\n keyValueIsEnvVar?: boolean\n }\n}\n```\n\n### `BasicAuthConfig`\n\nTo be sent only if authType is BASIC\n\n```ts\ntype BasicAuthConfig = {\n username: string\n password?: string\n passwordIsEnvVar?: boolean\n}\n```\n\n### `OAuthConfig`\n\nTo be sent only if authType is OAUTH_CLIENT_CREDENTIALS\n\n```ts\ntype OAuthConfig = {\n clientId: string\n clientSecret?: string\n clientSecretIsEnvVar?: boolean\n endpoint: string\n httpMethod: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD"\n customParameterList?: Array<{\n type: "body" | "query" | "header"\n key: string\n value: string\n }>\n}\n```\n\n### `ApiKeyConfig`\n\nTo be sent only if authType is API_KEY\n\n```ts\ntype ApiKeyConfig = {\n keyName: string\n keyValue?: string\n keyValueIsEnvVar?: boolean\n}\n```\n\n### `WebhookConfig`\n\n```ts\ntype WebhookConfig = {\n id?: string\n name: string\n eventName: string\n url?: string\n creationTime?: string\n httpMethod?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD"\n enabled?: boolean\n auth?: {\n authType: "BASIC" | "OAUTH_CLIENT_CREDENTIALS" | "API_KEY" | "NONE"\n basicAuthConfig?: {\n username: { ... }\n password?: { ... }\n passwordIsEnvVar?: { ... }\n }\n oauthConfig?: {\n clientId: { ... }\n clientSecret?: { ... }\n clientSecretIsEnvVar?: { ... }\n endpoint: { ... }\n httpMethod: { ... }\n customParameterList?: { ... }\n }\n apiKeyConfig?: {\n keyName: { ... }\n keyValue?: { ... }\n keyValueIsEnvVar?: { ... }\n }\n }\n filter?: {\n keyToFilter: string\n supportedValues: string[]\n }\n payloadConfiguration?: {\n hydrate_entity?: boolean\n include_relations?: boolean\n include_activity?: boolean\n include_changed_attributes?: boolean\n custom_headers?: Record<string, string>\n }\n enableStaticIP?: boolean\n protected?: boolean\n secureProxy?: {\n integration_id: string // uuid\n use_case_slug: string\n }\n status?: "active" | "inactive" | "incomplete"\n jsonataExpression?: string\n filterConditions?: {\n conditions?: Array<{\n field: { ... }\n operation: { ... }\n values?: { ... }\n field_type?: { ... }\n is_array_field?: { ... }\n repeatable_item_op?: { ... }\n }>\n logical_operator?: "AND" | "OR"\n }\n _manifest?: string // uuid[]\n signingSecret?: string\n}\n```\n\n### `EventConfigResp`\n\n```ts\ntype EventConfigResp = Array<{\n eventName?: string\n eventLabel?: string\n}>\n```\n\n### `EventConfigEntry`\n\n```ts\ntype EventConfigEntry = {\n eventName?: string\n eventLabel?: string\n}\n```\n\n### `ErrorResp`\n\n```ts\ntype ErrorResp = {\n message?: string\n}\n```\n\n### `TriggerWebhookResp`\n\n```ts\ntype TriggerWebhookResp = {\n status_code?: string\n message?: string\n body?: object\n code?: string\n status?: "succeeded" | "failed"\n start_date?: string\n end_date?: string\n event_id: string\n}\n```\n\n### `PayloadConfiguration`\n\nConfiguration for the webhook payload\n\n```ts\ntype PayloadConfiguration = {\n hydrate_entity?: boolean\n include_relations?: boolean\n include_activity?: boolean\n include_changed_attributes?: boolean\n custom_headers?: Record<string, string>\n}\n```\n\n### `CustomHeader`\n\nObject representing custom headers as key-value pairs.\n\n```ts\ntype CustomHeader = Record<string, string>\n```\n\n### `CustomOAuthParameter`\n\nCustom key/value pair of either type body, query or header\n\n```ts\ntype CustomOAuthParameter = {\n type: "body" | "query" | "header"\n key: string\n value: string\n}\n```\n\n### `Metadata`\n\nContains the metadata about the configured event\n\n```ts\ntype Metadata = {\n action?: string\n origin?: string\n creation_timestamp?: string\n webhook_id?: string\n webhook_name?: string\n automation_name?: string\n organization_id: string\n user_id?: string\n correlation_id?: string\n execution_id?: string\n action_id?: string\n}\n```\n\n### `ExecutionPayload`\n\nPayload for triggering a webhook\n\n```ts\ntype ExecutionPayload = {\n metadata: {\n action?: string\n origin?: string\n creation_timestamp?: string\n webhook_id?: string\n webhook_name?: string\n automation_name?: string\n organization_id: string\n user_id?: string\n correlation_id?: string\n execution_id?: string\n action_id?: string\n }\n}\n```\n\n### `WebhookEvent`\n\n```ts\ntype WebhookEvent = {\n event_id: string\n org_id: string\n webhook_config_id: string\n url?: string\n created_at?: string\n event_name?: string\n http_response?: {\n status_code?: number\n message?: string\n body?: object\n code?: string\n }\n metadata?: {\n action?: string\n origin?: string\n creation_timestamp?: string\n webhook_id?: string\n webhook_name?: string\n automation_name?: string\n organization_id: string\n user_id?: string\n correlation_id?: string\n execution_id?: string\n action_id?: string\n }\n status?: "succeeded" | "failed" | "in_progress" | "skipped"\n http_method?: "GET" | "POST" | "PUT"\n payload?: string\n}\n```\n\n### `ExampleRequest`\n\n```ts\ntype ExampleRequest = {\n automation_id?: string\n}\n```\n\n### `ExampleResponse`\n\n```ts\ntype ExampleResponse = {\n metadata?: {\n action?: string\n origin?: string\n creation_timestamp?: string\n webhook_id?: string\n webhook_name?: string\n automation_name?: string\n organization_id: string\n user_id?: string\n correlation_id?: string\n execution_id?: string\n action_id?: string\n }\n entity?: Record<string, unknown>\n relations?: Record<string, unknown>[]\n}\n```\n\n### `BatchReplayRequest`\n\n```ts\ntype BatchReplayRequest = {\n eventIds: string[]\n}\n```\n';
5
- export {
6
- webhooks_default as default
7
- };