@epilot/sdk 2.1.0-rc.0 → 2.1.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 (357) hide show
  1. package/definitions/app.json +38 -0
  2. package/definitions/automation.json +2 -37
  3. package/definitions/blueprint-manifest-runtime.json +1 -1
  4. package/definitions/blueprint-manifest.json +115 -1
  5. package/definitions/customer-portal-runtime.json +1 -1
  6. package/definitions/customer-portal.json +279 -42
  7. package/definitions/data-management.json +10 -0
  8. package/definitions/email-template.json +25 -3
  9. package/definitions/entity.json +205 -3
  10. package/definitions/erp-integration-runtime.json +1 -1
  11. package/definitions/erp-integration.json +472 -13
  12. package/definitions/journey.json +257 -12
  13. package/definitions/kanban.json +630 -78
  14. package/definitions/organization-runtime.json +1 -1
  15. package/definitions/organization.json +614 -51
  16. package/definitions/workflow.json +40 -0
  17. package/dist/README-VG67PX4R.js +7 -0
  18. package/dist/README-W4B35MRN.cjs +7 -0
  19. package/dist/_index-AMVZBT2K.cjs +99 -0
  20. package/dist/_index-S6LFD3ER.js +99 -0
  21. package/dist/access-token-6BJDZSFE.cjs +7 -0
  22. package/dist/access-token-GSQZLDXR.js +7 -0
  23. package/dist/address-HA4RMRNQ.cjs +7 -0
  24. package/dist/address-QVJUGMOG.js +7 -0
  25. package/dist/address-suggestions-74244BAJ.js +7 -0
  26. package/dist/address-suggestions-IUQMYF27.cjs +7 -0
  27. package/dist/ai-agents-IZWFEUSH.js +7 -0
  28. package/dist/ai-agents-PWHKNRCX.cjs +7 -0
  29. package/dist/apis/access-token.cjs +10 -13
  30. package/dist/apis/access-token.js +7 -10
  31. package/dist/apis/address-suggestions.cjs +10 -13
  32. package/dist/apis/address-suggestions.js +7 -10
  33. package/dist/apis/address.cjs +10 -13
  34. package/dist/apis/address.js +7 -10
  35. package/dist/apis/ai-agents.cjs +10 -13
  36. package/dist/apis/ai-agents.js +7 -10
  37. package/dist/apis/app.cjs +10 -13
  38. package/dist/apis/app.js +7 -10
  39. package/dist/apis/audit-logs.cjs +10 -13
  40. package/dist/apis/audit-logs.js +7 -10
  41. package/dist/apis/automation.cjs +10 -13
  42. package/dist/apis/automation.js +7 -10
  43. package/dist/apis/billing.cjs +10 -13
  44. package/dist/apis/billing.js +7 -10
  45. package/dist/apis/blueprint-manifest.cjs +10 -13
  46. package/dist/apis/blueprint-manifest.js +7 -10
  47. package/dist/apis/consent.cjs +10 -13
  48. package/dist/apis/consent.js +7 -10
  49. package/dist/apis/customer-portal.cjs +10 -13
  50. package/dist/apis/customer-portal.js +7 -10
  51. package/dist/apis/dashboard.cjs +10 -13
  52. package/dist/apis/dashboard.js +7 -10
  53. package/dist/apis/data-management.cjs +10 -13
  54. package/dist/apis/data-management.js +7 -10
  55. package/dist/apis/deduplication.cjs +10 -13
  56. package/dist/apis/deduplication.js +7 -10
  57. package/dist/apis/design.cjs +10 -13
  58. package/dist/apis/design.js +7 -10
  59. package/dist/apis/document.cjs +10 -13
  60. package/dist/apis/document.js +7 -10
  61. package/dist/apis/email-settings.cjs +10 -13
  62. package/dist/apis/email-settings.js +7 -10
  63. package/dist/apis/email-template.cjs +10 -13
  64. package/dist/apis/email-template.js +7 -10
  65. package/dist/apis/entity-mapping.cjs +10 -13
  66. package/dist/apis/entity-mapping.js +7 -10
  67. package/dist/apis/entity.cjs +10 -13
  68. package/dist/apis/entity.js +7 -10
  69. package/dist/apis/environments.cjs +10 -13
  70. package/dist/apis/environments.js +7 -10
  71. package/dist/apis/erp-integration.cjs +10 -13
  72. package/dist/apis/erp-integration.js +7 -10
  73. package/dist/apis/event-catalog.cjs +10 -13
  74. package/dist/apis/event-catalog.js +7 -10
  75. package/dist/apis/file.cjs +10 -13
  76. package/dist/apis/file.js +7 -10
  77. package/dist/apis/iban.cjs +10 -13
  78. package/dist/apis/iban.js +7 -10
  79. package/dist/apis/journey.cjs +10 -13
  80. package/dist/apis/journey.js +7 -10
  81. package/dist/apis/kanban.cjs +10 -13
  82. package/dist/apis/kanban.js +7 -10
  83. package/dist/apis/message.cjs +10 -13
  84. package/dist/apis/message.js +7 -10
  85. package/dist/apis/metering.cjs +10 -13
  86. package/dist/apis/metering.js +7 -10
  87. package/dist/apis/notes.cjs +10 -13
  88. package/dist/apis/notes.js +7 -10
  89. package/dist/apis/notification.cjs +10 -13
  90. package/dist/apis/notification.js +7 -10
  91. package/dist/apis/organization.cjs +10 -13
  92. package/dist/apis/organization.d.cts +2 -2
  93. package/dist/apis/organization.d.ts +2 -2
  94. package/dist/apis/organization.js +7 -10
  95. package/dist/apis/partner-directory.cjs +10 -13
  96. package/dist/apis/partner-directory.js +7 -10
  97. package/dist/apis/permissions.cjs +10 -13
  98. package/dist/apis/permissions.js +7 -10
  99. package/dist/apis/pricing-tier.cjs +10 -13
  100. package/dist/apis/pricing-tier.js +7 -10
  101. package/dist/apis/pricing.cjs +10 -13
  102. package/dist/apis/pricing.js +7 -10
  103. package/dist/apis/purpose.cjs +10 -13
  104. package/dist/apis/purpose.js +7 -10
  105. package/dist/apis/sandbox.cjs +10 -13
  106. package/dist/apis/sandbox.js +7 -10
  107. package/dist/apis/submission.cjs +10 -13
  108. package/dist/apis/submission.js +7 -10
  109. package/dist/apis/targeting.cjs +10 -13
  110. package/dist/apis/targeting.js +7 -10
  111. package/dist/apis/template-variables.cjs +10 -13
  112. package/dist/apis/template-variables.js +7 -10
  113. package/dist/apis/user.cjs +10 -13
  114. package/dist/apis/user.js +7 -10
  115. package/dist/apis/validation-rules.cjs +10 -13
  116. package/dist/apis/validation-rules.js +7 -10
  117. package/dist/apis/webhooks.cjs +10 -13
  118. package/dist/apis/webhooks.js +7 -10
  119. package/dist/apis/workflow-definition.cjs +10 -13
  120. package/dist/apis/workflow-definition.js +7 -10
  121. package/dist/apis/workflow.cjs +10 -13
  122. package/dist/apis/workflow.js +7 -10
  123. package/dist/app-IKHWU222.cjs +7 -0
  124. package/dist/app-VLM3SWKA.js +7 -0
  125. package/dist/audit-logs-5VXHOQ7S.js +7 -0
  126. package/dist/audit-logs-D2LFUA2R.cjs +7 -0
  127. package/dist/automation-3HGCK725.cjs +7 -0
  128. package/dist/automation-72VGEJCY.js +7 -0
  129. package/dist/billing-DUWDISHP.cjs +7 -0
  130. package/dist/billing-IPALEAG2.js +7 -0
  131. package/dist/blueprint-manifest-CXSCRQ5X.js +7 -0
  132. package/dist/blueprint-manifest-SHNZPK5O.cjs +7 -0
  133. package/dist/chunk-2HOJWFQ4.js +14 -0
  134. package/dist/chunk-372VUPHN.js +14 -0
  135. package/dist/chunk-3HJEWWPS.cjs +14 -0
  136. package/dist/chunk-3N67SSL3.js +14 -0
  137. package/dist/chunk-3XEP56SV.cjs +204 -0
  138. package/dist/chunk-3ZZ57K3S.cjs +14 -0
  139. package/dist/chunk-4SWC43JO.cjs +14 -0
  140. package/dist/chunk-4VFQTSJQ.js +14 -0
  141. package/dist/chunk-57QIBYDN.js +14 -0
  142. package/dist/chunk-5SNJAD6F.cjs +14 -0
  143. package/dist/chunk-73H6TVKN.js +14 -0
  144. package/dist/chunk-A6JOROUC.cjs +14 -0
  145. package/dist/chunk-AJKH25H2.cjs +14 -0
  146. package/dist/chunk-ARWMTXJV.cjs +14 -0
  147. package/dist/chunk-B3ZGAG7B.js +14 -0
  148. package/dist/chunk-BH5ZXK4J.cjs +14 -0
  149. package/dist/chunk-BWFXLUK5.cjs +14 -0
  150. package/dist/chunk-C6UTZEHH.js +14 -0
  151. package/dist/chunk-CPKBR34V.js +14 -0
  152. package/dist/chunk-CWSHYFVZ.js +14 -0
  153. package/dist/chunk-DJKSULPK.js +14 -0
  154. package/dist/chunk-DNJ54L2G.js +14 -0
  155. package/dist/chunk-DY2D2IW5.cjs +14 -0
  156. package/dist/chunk-E26ZO7QM.cjs +14 -0
  157. package/dist/chunk-EBCHCYUO.js +14 -0
  158. package/dist/chunk-EPAIOB5U.cjs +14 -0
  159. package/dist/chunk-EQZMT2HF.cjs +14 -0
  160. package/dist/chunk-F376L6PP.cjs +14 -0
  161. package/dist/chunk-F472YLJG.cjs +14 -0
  162. package/dist/chunk-FXOX3X7E.cjs +14 -0
  163. package/dist/chunk-G2REP2VZ.cjs +14 -0
  164. package/dist/chunk-GLO477NZ.js +14 -0
  165. package/dist/chunk-H4VSK4KF.js +14 -0
  166. package/dist/chunk-HPSGM6QP.js +14 -0
  167. package/dist/chunk-HPYHWTTA.cjs +14 -0
  168. package/dist/chunk-IH4CMOML.js +14 -0
  169. package/dist/chunk-IMT3IE5M.cjs +14 -0
  170. package/dist/chunk-IP2WWEOU.js +14 -0
  171. package/dist/chunk-IS2VB342.js +14 -0
  172. package/dist/chunk-ITX53XAZ.js +14 -0
  173. package/dist/chunk-JXBXDTFG.cjs +14 -0
  174. package/dist/chunk-K62XK7KU.js +14 -0
  175. package/dist/chunk-KA3TGFJP.js +14 -0
  176. package/dist/chunk-KBOVBUBM.js +14 -0
  177. package/dist/chunk-KPGC2D6E.js +14 -0
  178. package/dist/chunk-KSXTBGIV.js +14 -0
  179. package/dist/chunk-LCIJ4TJ4.cjs +14 -0
  180. package/dist/chunk-LQOLYXGQ.cjs +14 -0
  181. package/dist/chunk-LSIWCIQV.js +14 -0
  182. package/dist/chunk-MHNSZ4HE.js +14 -0
  183. package/dist/chunk-MKX4CKAB.cjs +14 -0
  184. package/dist/chunk-MRTAFRO7.js +14 -0
  185. package/dist/chunk-MRZ7LGKZ.js +14 -0
  186. package/dist/chunk-MSASBR2Y.js +14 -0
  187. package/dist/chunk-NAWLLC3T.cjs +14 -0
  188. package/dist/chunk-NJK5F5TF.cjs +21 -0
  189. package/dist/chunk-NLSZVGHK.cjs +14 -0
  190. package/dist/chunk-O4LRVGOY.js +14 -0
  191. package/dist/chunk-OG2DMGU6.cjs +14 -0
  192. package/dist/chunk-OGQKJTXF.js +14 -0
  193. package/dist/chunk-PETLAONH.js +14 -0
  194. package/dist/chunk-PVSS2WPM.cjs +14 -0
  195. package/dist/chunk-PXITFTJA.cjs +14 -0
  196. package/dist/chunk-QDVPPRWI.cjs +14 -0
  197. package/dist/chunk-QKERXNJJ.cjs +14 -0
  198. package/dist/chunk-QLML3IP5.cjs +14 -0
  199. package/dist/chunk-QVAJ5JP4.js +14 -0
  200. package/dist/chunk-RD7E4OSJ.cjs +14 -0
  201. package/dist/chunk-RWSA3LXE.cjs +14 -0
  202. package/dist/chunk-RXSS67VI.cjs +14 -0
  203. package/dist/chunk-S3ZNESMC.cjs +14 -0
  204. package/dist/chunk-S7NDMDRX.js +14 -0
  205. package/dist/chunk-SK3VYIZ6.cjs +14 -0
  206. package/dist/chunk-SMGHAG5C.cjs +14 -0
  207. package/dist/chunk-T46LODOF.js +14 -0
  208. package/dist/chunk-TIJWJVKZ.js +14 -0
  209. package/dist/chunk-TLWCYLNA.js +14 -0
  210. package/dist/chunk-TRJLYZHD.js +14 -0
  211. package/dist/chunk-UKKJMCNH.js +14 -0
  212. package/dist/chunk-ULBEEHG4.js +204 -0
  213. package/dist/chunk-VGTUK3QD.cjs +14 -0
  214. package/dist/chunk-VQ7R36AC.js +14 -0
  215. package/dist/chunk-VVQB5W7U.cjs +14 -0
  216. package/dist/chunk-VVVATFGK.cjs +14 -0
  217. package/dist/chunk-WMTYO5OX.cjs +14 -0
  218. package/dist/chunk-WOSSSFXB.js +14 -0
  219. package/dist/chunk-WOXXNKTE.js +14 -0
  220. package/dist/chunk-XKI2OAYV.cjs +14 -0
  221. package/dist/chunk-XR4QF6KQ.cjs +14 -0
  222. package/dist/chunk-XYHTQ523.cjs +14 -0
  223. package/dist/chunk-XZYZLSUO.cjs +14 -0
  224. package/dist/chunk-YPSWSI3M.js +21 -0
  225. package/dist/chunk-YYBIU5BQ.js +14 -0
  226. package/dist/chunk-YZA5WZUS.js +14 -0
  227. package/dist/chunk-Z4LUE424.cjs +14 -0
  228. package/dist/chunk-ZV6XYUXS.js +14 -0
  229. package/dist/consent-CS2ZBZX4.cjs +7 -0
  230. package/dist/consent-NNYHF2N4.js +7 -0
  231. package/dist/customer-portal-D3SLPAHZ.js +7 -0
  232. package/dist/customer-portal-UR3GN4VU.cjs +7 -0
  233. package/dist/dashboard-UHYR5RTY.cjs +7 -0
  234. package/dist/dashboard-UTPGXFW5.js +7 -0
  235. package/dist/data-management-QH2IJ5QV.js +7 -0
  236. package/dist/data-management-TEFRLGSU.cjs +7 -0
  237. package/dist/deduplication-ECVAZVVA.cjs +7 -0
  238. package/dist/deduplication-GYIST22B.js +7 -0
  239. package/dist/design-KUVXMFFK.cjs +7 -0
  240. package/dist/design-YKBXRW5C.js +7 -0
  241. package/dist/document-CY2A2OE7.js +7 -0
  242. package/dist/document-RYQ7MF6U.cjs +7 -0
  243. package/dist/email-settings-TQ5GGDYG.js +7 -0
  244. package/dist/email-settings-TQC34GST.cjs +7 -0
  245. package/dist/email-template-M2VVL4TI.cjs +7 -0
  246. package/dist/email-template-WYROV3UG.js +7 -0
  247. package/dist/entity-FA6PZX6S.js +7 -0
  248. package/dist/entity-IX5NSHPX.cjs +7 -0
  249. package/dist/entity-mapping-7J3IAGKQ.js +7 -0
  250. package/dist/entity-mapping-ZNMFCUKK.cjs +7 -0
  251. package/dist/environments-E3X6NYGX.js +7 -0
  252. package/dist/environments-P2JS4F5N.cjs +7 -0
  253. package/dist/erp-integration-EP2XFEH5.js +7 -0
  254. package/dist/erp-integration-NNV72VFI.cjs +7 -0
  255. package/dist/event-catalog-C45ISVMP.cjs +7 -0
  256. package/dist/event-catalog-D7VJ7WRS.js +7 -0
  257. package/dist/file-UOWBTDIU.cjs +7 -0
  258. package/dist/file-XSN3NAVZ.js +7 -0
  259. package/dist/iban-24GHLFDB.cjs +7 -0
  260. package/dist/iban-LDKYDVQV.js +7 -0
  261. package/dist/index.cjs +199 -58
  262. package/dist/index.d.cts +17 -2
  263. package/dist/index.d.ts +17 -2
  264. package/dist/index.js +197 -56
  265. package/dist/journey-7CKX67M7.js +7 -0
  266. package/dist/journey-EUZ6MVHG.cjs +7 -0
  267. package/dist/kanban-CHTH2ZSY.cjs +7 -0
  268. package/dist/kanban-HI6LL5WY.js +7 -0
  269. package/dist/message-3XZLJR6R.cjs +7 -0
  270. package/dist/message-ZNMCS5YH.js +7 -0
  271. package/dist/metering-DZNZPPY6.cjs +7 -0
  272. package/dist/metering-KOSCPPKB.js +7 -0
  273. package/dist/notes-3AO5GXIT.js +7 -0
  274. package/dist/notes-MPWOQC5J.cjs +7 -0
  275. package/dist/notification-PZOCUYD5.cjs +7 -0
  276. package/dist/notification-VWDZRSFZ.js +7 -0
  277. package/dist/organization-RARYYG2E.cjs +7 -0
  278. package/dist/organization-ZERPH2IH.js +7 -0
  279. package/dist/{organization.d-Bd2Hmk8v.d.cts → organization.d-DqwnNxMg.d.cts} +34 -7
  280. package/dist/{organization.d-Bd2Hmk8v.d.ts → organization.d-DqwnNxMg.d.ts} +34 -7
  281. package/dist/partner-directory-2XMPQWWX.js +7 -0
  282. package/dist/partner-directory-WHNTKQ5E.cjs +7 -0
  283. package/dist/permissions-4T3GFNB4.js +7 -0
  284. package/dist/permissions-FGBIJNN7.cjs +7 -0
  285. package/dist/pricing-4Z4TOETA.cjs +7 -0
  286. package/dist/pricing-C65DTZSX.js +7 -0
  287. package/dist/pricing-tier-NI35WOUP.cjs +7 -0
  288. package/dist/pricing-tier-VUOFK5Q7.js +7 -0
  289. package/dist/purpose-AKOEUHZ4.cjs +7 -0
  290. package/dist/purpose-RBRV3AQZ.js +7 -0
  291. package/dist/sandbox-2KN4X66E.cjs +7 -0
  292. package/dist/sandbox-L2SOOGGR.js +7 -0
  293. package/dist/submission-7BISSPO6.js +7 -0
  294. package/dist/submission-Q24BU4GS.cjs +7 -0
  295. package/dist/targeting-EYGYZD6M.cjs +7 -0
  296. package/dist/targeting-GEJTJN5Z.js +7 -0
  297. package/dist/template-variables-OAYS2E3G.cjs +1148 -0
  298. package/dist/template-variables-VKDJJZUT.js +1148 -0
  299. package/dist/user-EIEOI3OG.js +7 -0
  300. package/dist/user-NJJ7XVKB.cjs +7 -0
  301. package/dist/validation-rules-P6F5P73P.js +7 -0
  302. package/dist/validation-rules-VDU3CIZV.cjs +7 -0
  303. package/dist/webhooks-I7JWU34X.cjs +7 -0
  304. package/dist/webhooks-WPLEHVPX.js +7 -0
  305. package/dist/workflow-3LLURW3H.js +7 -0
  306. package/dist/workflow-RAGQDYXT.cjs +7 -0
  307. package/dist/workflow-definition-B6ELOZUR.cjs +7 -0
  308. package/dist/workflow-definition-D24CRCK2.js +7 -0
  309. package/docs/access-token.md +440 -0
  310. package/docs/address-suggestions.md +256 -0
  311. package/docs/address.md +284 -0
  312. package/docs/ai-agents.md +1891 -0
  313. package/docs/app.md +3388 -0
  314. package/docs/audit-logs.md +242 -0
  315. package/docs/automation.md +4044 -0
  316. package/docs/billing.md +783 -0
  317. package/docs/blueprint-manifest.md +3234 -0
  318. package/docs/consent.md +213 -0
  319. package/docs/customer-portal.md +11399 -0
  320. package/docs/dashboard.md +640 -0
  321. package/docs/data-management.md +883 -0
  322. package/docs/deduplication.md +135 -0
  323. package/docs/design.md +1273 -0
  324. package/docs/document.md +590 -0
  325. package/docs/email-settings.md +1544 -0
  326. package/docs/email-template.md +1197 -0
  327. package/docs/entity-mapping.md +2864 -0
  328. package/docs/entity.md +9595 -0
  329. package/docs/environments.md +259 -0
  330. package/docs/erp-integration.md +4572 -0
  331. package/docs/event-catalog.md +835 -0
  332. package/docs/file.md +1453 -0
  333. package/docs/iban.md +61 -0
  334. package/docs/journey.md +2268 -0
  335. package/docs/kanban.md +882 -0
  336. package/docs/message.md +2122 -0
  337. package/docs/metering.md +1431 -0
  338. package/docs/notes.md +670 -0
  339. package/docs/notification.md +1207 -0
  340. package/docs/organization.md +733 -0
  341. package/docs/partner-directory.md +1197 -0
  342. package/docs/permissions.md +1047 -0
  343. package/docs/pricing-tier.md +81 -0
  344. package/docs/pricing.md +5923 -0
  345. package/docs/purpose.md +283 -0
  346. package/docs/sandbox.md +389 -0
  347. package/docs/submission.md +195 -0
  348. package/docs/targeting.md +959 -0
  349. package/docs/template-variables.md +1141 -0
  350. package/docs/user.md +2555 -0
  351. package/docs/validation-rules.md +1597 -0
  352. package/docs/webhooks.md +996 -0
  353. package/docs/workflow-definition.md +3842 -0
  354. package/docs/workflow.md +4465 -0
  355. package/package.json +3 -2
  356. package/dist/chunk-XE25WERA.js +0 -125
  357. package/dist/chunk-XEQMAKGA.cjs +0 -125
@@ -0,0 +1,4044 @@
1
+ # Automation API
2
+
3
+ - **Base URL:** `https://automation.sls.epilot.io`
4
+ - **Full API Docs:** [https://docs.epilot.io/api/automation](https://docs.epilot.io/api/automation)
5
+
6
+ ## Usage
7
+
8
+ ```ts
9
+ import { epilot } from '@epilot/sdk'
10
+
11
+ epilot.authorize(() => '<token>')
12
+ const { data } = await epilot.automation.searchFlows(...)
13
+ ```
14
+
15
+ ### Tree-shakeable import
16
+
17
+ ```ts
18
+ import { getClient, authorize } from '@epilot/sdk/automation'
19
+
20
+ const automationClient = getClient()
21
+ authorize(automationClient, () => '<token>')
22
+ const { data } = await automationClient.searchFlows(...)
23
+ ```
24
+
25
+ ## Operations
26
+
27
+ **flows**
28
+ - [`searchFlows`](#searchflows)
29
+ - [`createFlow`](#createflow)
30
+ - [`batchGetFlows`](#batchgetflows)
31
+ - [`getFlow`](#getflow)
32
+ - [`putFlow`](#putflow)
33
+ - [`deleteFlow`](#deleteflow)
34
+
35
+ **executions**
36
+ - [`getExecutions`](#getexecutions)
37
+ - [`startExecution`](#startexecution)
38
+ - [`getExecution`](#getexecution)
39
+ - [`cancelExecution`](#cancelexecution)
40
+ - [`retriggerAction`](#retriggeraction)
41
+ - [`resumeExecutionWithToken`](#resumeexecutionwithtoken)
42
+ - [`cancelSchedule`](#cancelschedule)
43
+
44
+ **bulk**
45
+ - [`bulkTriggerExecutions`](#bulktriggerexecutions)
46
+ - [`getBulkJob`](#getbulkjob)
47
+ - [`patchBulkJob`](#patchbulkjob)
48
+
49
+ **Schemas**
50
+ - [`AutomationFlowId`](#automationflowid)
51
+ - [`AutomationActionId`](#automationactionid)
52
+ - [`AutomationFlow`](#automationflow)
53
+ - [`WorkflowContextRole`](#workflowcontextrole)
54
+ - [`SearchAutomationsResp`](#searchautomationsresp)
55
+ - [`AnyTrigger`](#anytrigger)
56
+ - [`AnyAction`](#anyaction)
57
+ - [`AnyActionConfig`](#anyactionconfig)
58
+ - [`AutomationActionConfig`](#automationactionconfig)
59
+ - [`AutomationActionExecutionState`](#automationactionexecutionstate)
60
+ - [`RetryStrategy`](#retrystrategy)
61
+ - [`AutomationAction`](#automationaction)
62
+ - [`ErrorOutput`](#erroroutput)
63
+ - [`ErrorCode`](#errorcode)
64
+ - [`ErrorDetail`](#errordetail)
65
+ - [`CartCheckoutActionConfig`](#cartcheckoutactionconfig)
66
+ - [`CartCheckoutAction`](#cartcheckoutaction)
67
+ - [`CartCheckoutConfig`](#cartcheckoutconfig)
68
+ - [`MapEntityActionConfig`](#mapentityactionconfig)
69
+ - [`MapEntityAction`](#mapentityaction)
70
+ - [`MapEntityConfig`](#mapentityconfig)
71
+ - [`MappingConfigRef`](#mappingconfigref)
72
+ - [`RelationAttribute`](#relationattribute)
73
+ - [`MappingAttributeV2`](#mappingattributev2)
74
+ - [`OperationNode`](#operationnode)
75
+ - [`OperationObjectNode`](#operationobjectnode)
76
+ - [`PrimitiveJSONValue`](#primitivejsonvalue)
77
+ - [`MappingAttribute`](#mappingattribute)
78
+ - [`MappingAttributeMode`](#mappingattributemode)
79
+ - [`SetValueMapper`](#setvaluemapper)
80
+ - [`CopyValueMapper`](#copyvaluemapper)
81
+ - [`AppendValueMapper`](#appendvaluemapper)
82
+ - [`MoveThreadAction`](#movethreadaction)
83
+ - [`AssignThreadAction`](#assignthreadaction)
84
+ - [`MoveThreadConfig`](#movethreadconfig)
85
+ - [`AssignThreadConfig`](#assignthreadconfig)
86
+ - [`SendEmailActionConfig`](#sendemailactionconfig)
87
+ - [`SendEmailAction`](#sendemailaction)
88
+ - [`SendEmailConfig`](#sendemailconfig)
89
+ - [`SendEmailCondition`](#sendemailcondition)
90
+ - [`CreateDocumentActionConfig`](#createdocumentactionconfig)
91
+ - [`CreateDocumentAction`](#createdocumentaction)
92
+ - [`CreateDocumentConfig`](#createdocumentconfig)
93
+ - [`TriggerWorkflowActionConfig`](#triggerworkflowactionconfig)
94
+ - [`TriggerWorkflowAction`](#triggerworkflowaction)
95
+ - [`TriggerWorkflowConfig`](#triggerworkflowconfig)
96
+ - [`TriggerWorkflowCondition`](#triggerworkflowcondition)
97
+ - [`TriggerShareEntityActionConfig`](#triggershareentityactionconfig)
98
+ - [`TriggerShareEntityAction`](#triggershareentityaction)
99
+ - [`TriggerShareEntityConfig`](#triggershareentityconfig)
100
+ - [`AssignUsersToStep`](#assignuserstostep)
101
+ - [`CustomAction`](#customaction)
102
+ - [`TriggerWebhookActionConfig`](#triggerwebhookactionconfig)
103
+ - [`TriggerWebhookAction`](#triggerwebhookaction)
104
+ - [`TriggerWebhookConfig`](#triggerwebhookconfig)
105
+ - [`InformERPActionConfig`](#informerpactionconfig)
106
+ - [`InformERPAction`](#informerpaction)
107
+ - [`InformERPConfig`](#informerpconfig)
108
+ - [`TriggerEventActionConfig`](#triggereventactionconfig)
109
+ - [`TriggerEventAction`](#triggereventaction)
110
+ - [`TriggerEventConfig`](#triggereventconfig)
111
+ - [`FlowExecutionCancelActionConfig`](#flowexecutioncancelactionconfig)
112
+ - [`FlowExecutionCancelAction`](#flowexecutioncancelaction)
113
+ - [`FlowExecutionCancelConfig`](#flowexecutioncancelconfig)
114
+ - [`CancellationReason`](#cancellationreason)
115
+ - [`ConditionStatement`](#conditionstatement)
116
+ - [`ActionCondition`](#actioncondition)
117
+ - [`ActionScheduleSource`](#actionschedulesource)
118
+ - [`ActionSchedule`](#actionschedule)
119
+ - [`AutomationExecutionId`](#automationexecutionid)
120
+ - [`AutomationExecution`](#automationexecution)
121
+ - [`WorkflowExecutionContext`](#workflowexecutioncontext)
122
+ - [`ExecutionChain`](#executionchain)
123
+ - [`TriggerEventManual`](#triggereventmanual)
124
+ - [`TriggerEventFlowAutomationTask`](#triggereventflowautomationtask)
125
+ - [`TriggerEventEntityActivity`](#triggerevententityactivity)
126
+ - [`TriggerEventMessaging`](#triggereventmessaging)
127
+ - [`TriggerEventEntityOperation`](#triggerevententityoperation)
128
+ - [`ApiCallerContext`](#apicallercontext)
129
+ - [`ExecutionStatus`](#executionstatus)
130
+ - [`GetExecutionsResp`](#getexecutionsresp)
131
+ - [`StartExecutionRequest`](#startexecutionrequest)
132
+ - [`PatchBulkJobRequest`](#patchbulkjobrequest)
133
+ - [`BulkTriggerRequest`](#bulktriggerrequest)
134
+ - [`EntityRef`](#entityref)
135
+ - [`BulkTriggerJob`](#bulktriggerjob)
136
+ - [`ExecItem`](#execitem)
137
+ - [`JobId`](#jobid)
138
+ - [`EntityId`](#entityid)
139
+ - [`ActivityId`](#activityid)
140
+ - [`OrganizationId`](#organizationid)
141
+ - [`TriggerContext`](#triggercontext)
142
+ - [`AutomationTrigger`](#automationtrigger)
143
+ - [`FlowsTrigger`](#flowstrigger)
144
+ - [`JourneySubmitTrigger`](#journeysubmittrigger)
145
+ - [`FrontendSubmitTrigger`](#frontendsubmittrigger)
146
+ - [`ApiSubmissionTrigger`](#apisubmissiontrigger)
147
+ - [`NewEmailThreadTrigger`](#newemailthreadtrigger)
148
+ - [`ReceivedEmailTrigger`](#receivedemailtrigger)
149
+ - [`EntityOperationTrigger`](#entityoperationtrigger)
150
+ - [`ActivityTrigger`](#activitytrigger)
151
+ - [`EntityOperation`](#entityoperation)
152
+ - [`EntitySearchFilter`](#entitysearchfilter)
153
+ - [`EntitySearchFilterValue`](#entitysearchfiltervalue)
154
+ - [`EntityManualTrigger`](#entitymanualtrigger)
155
+ - [`TriggerCondition`](#triggercondition)
156
+ - [`Comparison`](#comparison)
157
+ - [`FilterConditionOnEvent`](#filterconditiononevent)
158
+ - [`EqualsIgnoreCaseCondition`](#equalsignorecasecondition)
159
+ - [`AnythingButCondition`](#anythingbutcondition)
160
+ - [`NumericCondition`](#numericcondition)
161
+ - [`ExistsCondition`](#existscondition)
162
+ - [`PrefixCondition`](#prefixcondition)
163
+ - [`SuffixCondition`](#suffixcondition)
164
+ - [`WildcardCondition`](#wildcardcondition)
165
+ - [`OrCondition`](#orcondition)
166
+ - [`DiffAdded`](#diffadded)
167
+ - [`DiffUpdated`](#diffupdated)
168
+ - [`DiffDeleted`](#diffdeleted)
169
+ - [`OrConditionForDiff`](#orconditionfordiff)
170
+ - [`EntityItemSnapshot`](#entityitemsnapshot)
171
+ - [`RetryReq`](#retryreq)
172
+ - [`ResumeToken`](#resumetoken)
173
+ - [`ResumeReq`](#resumereq)
174
+ - [`ResumeResp`](#resumeresp)
175
+ - [`ErrorObject`](#errorobject)
176
+
177
+ ### `searchFlows`
178
+
179
+ Search available automation flows
180
+
181
+ `GET /v1/automation/flows`
182
+
183
+ ```ts
184
+ const { data } = await client.searchFlows({
185
+ schema: 'example',
186
+ size: 1,
187
+ from: 1,
188
+ trigger_source_id: 'example',
189
+ include_flows: true,
190
+ })
191
+ ```
192
+
193
+ ---
194
+
195
+ ### `createFlow`
196
+
197
+ Create new automation flow
198
+
199
+ `POST /v1/automation/flows`
200
+
201
+ ```ts
202
+ const { data } = await client.createFlow()
203
+ ```
204
+
205
+ ---
206
+
207
+ ### `batchGetFlows`
208
+
209
+ Get multiple automation flows by their IDs
210
+
211
+ `POST /v1/automation/flows:batchGet`
212
+
213
+ ```ts
214
+ const { data } = await client.batchGetFlows(
215
+ null,
216
+ {
217
+ ids: ['7791b04a-16d2-44a2-9af9-2d59c25c512f']
218
+ },
219
+ )
220
+ ```
221
+
222
+ ---
223
+
224
+ ### `getFlow`
225
+
226
+ List available automation flows
227
+
228
+ `GET /v1/automation/flows/{flow_id}`
229
+
230
+ ```ts
231
+ const { data } = await client.getFlow({
232
+ flow_id: 'example',
233
+ })
234
+ ```
235
+
236
+ ---
237
+
238
+ ### `putFlow`
239
+
240
+ Update automation flow by id
241
+
242
+ `PUT /v1/automation/flows/{flow_id}`
243
+
244
+ ```ts
245
+ const { data } = await client.putFlow({
246
+ flow_id: 'example',
247
+ })
248
+ ```
249
+
250
+ ---
251
+
252
+ ### `deleteFlow`
253
+
254
+ Update automation flow by id
255
+
256
+ `DELETE /v1/automation/flows/{flow_id}`
257
+
258
+ ```ts
259
+ const { data } = await client.deleteFlow({
260
+ flow_id: 'example',
261
+ })
262
+ ```
263
+
264
+ ---
265
+
266
+ ### `getExecutions`
267
+
268
+ List automation executions
269
+
270
+ `GET /v1/automation/executions`
271
+
272
+ ```ts
273
+ const { data } = await client.getExecutions({
274
+ entity_id: 'example',
275
+ size: 1,
276
+ from: 1,
277
+ include_flows: true,
278
+ })
279
+ ```
280
+
281
+ <details>
282
+ <summary>Response</summary>
283
+
284
+ ```json
285
+ {
286
+ "total": 0,
287
+ "results": [
288
+ {
289
+ "id": "9baf184f-bc81-4128-bca3-d974c90a12c4",
290
+ "execution_status": "pending",
291
+ "entity_id": "e3d3ebac-baab-4395-abf4-50b5bf1f8b74",
292
+ "activity_id": "e3d3ebac-baab-4395-abf4-50b5bf1f8b74",
293
+ "entity_snapshot": {},
294
+ "org_id": "e3d3ebac-baab-4395-abf4-50b5bf1f8b74",
295
+ "flow_id": "7791b04a-16d2-44a2-9af9-2d59c25c512f",
296
+ "flow_name": "Handle contact form",
297
+ "created_at": "1970-01-01T00:00:00.000Z",
298
+ "updated_at": "1970-01-01T00:00:00.000Z",
299
+ "current_action_id": "9ec3711b-db63-449c-b894-54d5bb622a8f",
300
+ "conditions": [],
301
+ "schedules": [],
302
+ "actions": [],
303
+ "resume_token": "eyJraWQiOiJrZXkifQ==",
304
+ "trigger_context": {},
305
+ "version": 2,
306
+ "trigger_event": {},
307
+ "workflow_context": {}
308
+ }
309
+ ]
310
+ }
311
+ ```
312
+
313
+ </details>
314
+
315
+ ---
316
+
317
+ ### `startExecution`
318
+
319
+ Start new automation execution
320
+
321
+ `POST /v1/automation/executions`
322
+
323
+ ```ts
324
+ const { data } = await client.startExecution(
325
+ null,
326
+ {
327
+ entity_id: 'e3d3ebac-baab-4395-abf4-50b5bf1f8b74',
328
+ flow_id: '7791b04a-16d2-44a2-9af9-2d59c25c512f',
329
+ workflow_context: {
330
+ workflow_exec_id: 'string',
331
+ workflow_exec_task_id: 'string',
332
+ workflow_role: 'trigger_workflow',
333
+ _execution_chain: {
334
+ parent_execution_id: 'string',
335
+ parent_task_id: 'string',
336
+ depth: 0
337
+ }
338
+ },
339
+ flow_execution_id: 'string',
340
+ flow_automation_task_id: 'string'
341
+ },
342
+ )
343
+ ```
344
+
345
+ <details>
346
+ <summary>Response</summary>
347
+
348
+ ```json
349
+ {
350
+ "id": "9baf184f-bc81-4128-bca3-d974c90a12c4",
351
+ "execution_status": "pending",
352
+ "entity_id": "e3d3ebac-baab-4395-abf4-50b5bf1f8b74",
353
+ "activity_id": "e3d3ebac-baab-4395-abf4-50b5bf1f8b74",
354
+ "entity_snapshot": {
355
+ "_id": "e3d3ebac-baab-4395-abf4-50b5bf1f8b74",
356
+ "_title": "string",
357
+ "_org": "string",
358
+ "_schema": "string",
359
+ "_tags": ["string"],
360
+ "_created_at": "1970-01-01T00:00:00.000Z",
361
+ "_updated_at": "1970-01-01T00:00:00.000Z"
362
+ },
363
+ "org_id": "e3d3ebac-baab-4395-abf4-50b5bf1f8b74",
364
+ "flow_id": "7791b04a-16d2-44a2-9af9-2d59c25c512f",
365
+ "flow_name": "Handle contact form",
366
+ "created_at": "1970-01-01T00:00:00.000Z",
367
+ "updated_at": "1970-01-01T00:00:00.000Z",
368
+ "current_action_id": "9ec3711b-db63-449c-b894-54d5bb622a8f",
369
+ "conditions": [
370
+ {
371
+ "id": "string",
372
+ "schedule_id": "string",
373
+ "evaluationResult": true,
374
+ "statements": []
375
+ }
376
+ ],
377
+ "schedules": [
378
+ {
379
+ "id": "string",
380
+ "scheduleApiId": "string",
381
+ "numberOfUnits": 0,
382
+ "timePeriod": "minutes",
383
+ "timeRelation": "after",
384
+ "source": {}
385
+ }
386
+ ],
387
+ "actions": [
388
+ {
389
+ "id": "9ec3711b-db63-449c-b894-54d5bb622a8f",
390
+ "flow_action_id": "9ec3711b-db63-449c-b894-54d5bb622a8f",
391
+ "name": "string",
392
+ "type": "map-entity",
393
+ "config": {},
394
+ "allow_failure": true,
395
+ "created_automatically": true,
396
+ "is_bulk_action": true,
397
+ "reason": {},
398
+ "condition_id": "string",
399
+ "schedule_id": "string",
400
+ "execution_status": "pending",
401
+ "started_at": "string",
402
+ "updated_at": "string",
403
+ "outputs": {},
404
+ "error_output": {},
405
+ "retry_strategy": "RETRY_AND_RESUME"
406
+ },
407
+ {
408
+ "id": "9ec3711b-db63-449c-b894-54d5bb622a8f",
409
+ "flow_action_id": "9ec3711b-db63-449c-b894-54d5bb622a8f",
410
+ "name": "string",
411
+ "type": "trigger-workflow",
412
+ "config": {},
413
+ "allow_failure": true,
414
+ "created_automatically": true,
415
+ "is_bulk_action": true,
416
+ "reason": {},
417
+ "condition_id": "string",
418
+ "schedule_id": "string",
419
+ "execution_status": "pending",
420
+ "started_at": "string",
421
+ "updated_at": "string",
422
+ "outputs": {},
423
+ "error_output": {},
424
+ "retry_strategy": "RETRY_AND_RESUME"
425
+ }
426
+ ],
427
+ "resume_token": "eyJraWQiOiJrZXkifQ==",
428
+ "trigger_context": {
429
+ "entity_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
430
+ },
431
+ "version": 2,
432
+ "trigger_event": {
433
+ "type": "manual",
434
+ "org_id": "123",
435
+ "entity_id": "e3d3ebac-baab-4395-abf4-50b5bf1f8b74",
436
+ "caller": {
437
+ "EpilotAuth": {}
438
+ }
439
+ },
440
+ "workflow_context": {
441
+ "workflow_exec_id": "string",
442
+ "workflow_exec_task_id": "string",
443
+ "workflow_role": "trigger_workflow",
444
+ "_execution_chain": {
445
+ "parent_execution_id": "string",
446
+ "parent_task_id": "string",
447
+ "depth": 0
448
+ }
449
+ }
450
+ }
451
+ ```
452
+
453
+ </details>
454
+
455
+ ---
456
+
457
+ ### `bulkTriggerExecutions`
458
+
459
+ Create a bulk job that triggers multiple automation executions
460
+
461
+ `POST /v1/automation/executions/bulk-jobs`
462
+
463
+ ```ts
464
+ const { data } = await client.bulkTriggerExecutions(
465
+ null,
466
+ {
467
+ flow_id: '7791b04a-16d2-44a2-9af9-2d59c25c512f',
468
+ entities_refs: [
469
+ {
470
+ entity_id: 'e3d3ebac-baab-4395-abf4-50b5bf1f8b74',
471
+ entity_schema: 'string'
472
+ }
473
+ ],
474
+ trigger_context: {
475
+ entity_id: 'a1b2c3d4-e5f6-7890-1234-567890abcdef'
476
+ }
477
+ },
478
+ )
479
+ ```
480
+
481
+ ---
482
+
483
+ ### `getBulkJob`
484
+
485
+ Get the status of a bulk job that triggers multiple automation executions
486
+
487
+ `GET /v1/automation/executions/bulk-jobs/{job_id}`
488
+
489
+ ```ts
490
+ const { data } = await client.getBulkJob({
491
+ job_id: 'example',
492
+ })
493
+ ```
494
+
495
+ <details>
496
+ <summary>Response</summary>
497
+
498
+ ```json
499
+ {
500
+ "job_id": "8c086140-f33e-4bb7-a993-50c0f2402c7b",
501
+ "org_id": "e3d3ebac-baab-4395-abf4-50b5bf1f8b74",
502
+ "flow_id": "7791b04a-16d2-44a2-9af9-2d59c25c512f",
503
+ "status": "approval",
504
+ "created_by": "1234",
505
+ "created_at": "1970-01-01T00:00:00.000Z",
506
+ "updated_at": "1970-01-01T00:00:00.000Z",
507
+ "approved_at": "1970-01-01T00:00:00.000Z",
508
+ "trigger_context": {
509
+ "entity_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
510
+ },
511
+ "task_token": "8c086140-f33e-4bb7-a993-50c0f2402c7b",
512
+ "report_file_entity_id": "string",
513
+ "entity_query": {
514
+ "type": "refs",
515
+ "data": [
516
+ {
517
+ "entity_id": "e3d3ebac-baab-4395-abf4-50b5bf1f8b74",
518
+ "entity_schema": "string"
519
+ }
520
+ ]
521
+ },
522
+ "pagination_state": {
523
+ "page_size": 0,
524
+ "pages_processed": 0,
525
+ "total_processed": 0,
526
+ "stable_query_id": "string",
527
+ "search_after": ["string"],
528
+ "has_more": true
529
+ },
530
+ "execution_summary": [
531
+ {
532
+ "entity_id": "e3d3ebac-baab-4395-abf4-50b5bf1f8b74",
533
+ "entity_schema": "string",
534
+ "execution_id": "9baf184f-bc81-4128-bca3-d974c90a12c4",
535
+ "execution_status": "pending",
536
+ "timestamp": "2025-10-30T15:56:47.842Z",
537
+ "error": "string"
538
+ }
539
+ ]
540
+ }
541
+ ```
542
+
543
+ </details>
544
+
545
+ ---
546
+
547
+ ### `patchBulkJob`
548
+
549
+ Approve / Cancel bulk job that triggers multiple automation executions
550
+
551
+ `PATCH /v1/automation/executions/bulk-jobs/{job_id}`
552
+
553
+ ```ts
554
+ const { data } = await client.patchBulkJob(
555
+ {
556
+ job_id: 'example',
557
+ },
558
+ {
559
+ action: 'APPROVE',
560
+ task_token: 'string'
561
+ },
562
+ )
563
+ ```
564
+
565
+ <details>
566
+ <summary>Response</summary>
567
+
568
+ ```json
569
+ {
570
+ "job_id": "8c086140-f33e-4bb7-a993-50c0f2402c7b",
571
+ "org_id": "e3d3ebac-baab-4395-abf4-50b5bf1f8b74",
572
+ "flow_id": "7791b04a-16d2-44a2-9af9-2d59c25c512f",
573
+ "status": "approval",
574
+ "created_by": "1234",
575
+ "created_at": "1970-01-01T00:00:00.000Z",
576
+ "updated_at": "1970-01-01T00:00:00.000Z",
577
+ "approved_at": "1970-01-01T00:00:00.000Z",
578
+ "trigger_context": {
579
+ "entity_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
580
+ },
581
+ "task_token": "8c086140-f33e-4bb7-a993-50c0f2402c7b",
582
+ "report_file_entity_id": "string",
583
+ "entity_query": {
584
+ "type": "refs",
585
+ "data": [
586
+ {
587
+ "entity_id": "e3d3ebac-baab-4395-abf4-50b5bf1f8b74",
588
+ "entity_schema": "string"
589
+ }
590
+ ]
591
+ },
592
+ "pagination_state": {
593
+ "page_size": 0,
594
+ "pages_processed": 0,
595
+ "total_processed": 0,
596
+ "stable_query_id": "string",
597
+ "search_after": ["string"],
598
+ "has_more": true
599
+ },
600
+ "execution_summary": [
601
+ {
602
+ "entity_id": "e3d3ebac-baab-4395-abf4-50b5bf1f8b74",
603
+ "entity_schema": "string",
604
+ "execution_id": "9baf184f-bc81-4128-bca3-d974c90a12c4",
605
+ "execution_status": "pending",
606
+ "timestamp": "2025-10-30T15:56:47.842Z",
607
+ "error": "string"
608
+ }
609
+ ]
610
+ }
611
+ ```
612
+
613
+ </details>
614
+
615
+ ---
616
+
617
+ ### `getExecution`
618
+
619
+ Get automation execution
620
+
621
+ `GET /v1/automation/executions/{execution_id}`
622
+
623
+ ```ts
624
+ const { data } = await client.getExecution({
625
+ execution_id: 'example',
626
+ })
627
+ ```
628
+
629
+ <details>
630
+ <summary>Response</summary>
631
+
632
+ ```json
633
+ {
634
+ "id": "9baf184f-bc81-4128-bca3-d974c90a12c4",
635
+ "execution_status": "pending",
636
+ "entity_id": "e3d3ebac-baab-4395-abf4-50b5bf1f8b74",
637
+ "activity_id": "e3d3ebac-baab-4395-abf4-50b5bf1f8b74",
638
+ "entity_snapshot": {
639
+ "_id": "e3d3ebac-baab-4395-abf4-50b5bf1f8b74",
640
+ "_title": "string",
641
+ "_org": "string",
642
+ "_schema": "string",
643
+ "_tags": ["string"],
644
+ "_created_at": "1970-01-01T00:00:00.000Z",
645
+ "_updated_at": "1970-01-01T00:00:00.000Z"
646
+ },
647
+ "org_id": "e3d3ebac-baab-4395-abf4-50b5bf1f8b74",
648
+ "flow_id": "7791b04a-16d2-44a2-9af9-2d59c25c512f",
649
+ "flow_name": "Handle contact form",
650
+ "created_at": "1970-01-01T00:00:00.000Z",
651
+ "updated_at": "1970-01-01T00:00:00.000Z",
652
+ "current_action_id": "9ec3711b-db63-449c-b894-54d5bb622a8f",
653
+ "conditions": [
654
+ {
655
+ "id": "string",
656
+ "schedule_id": "string",
657
+ "evaluationResult": true,
658
+ "statements": []
659
+ }
660
+ ],
661
+ "schedules": [
662
+ {
663
+ "id": "string",
664
+ "scheduleApiId": "string",
665
+ "numberOfUnits": 0,
666
+ "timePeriod": "minutes",
667
+ "timeRelation": "after",
668
+ "source": {}
669
+ }
670
+ ],
671
+ "actions": [
672
+ {
673
+ "id": "9ec3711b-db63-449c-b894-54d5bb622a8f",
674
+ "flow_action_id": "9ec3711b-db63-449c-b894-54d5bb622a8f",
675
+ "name": "string",
676
+ "type": "map-entity",
677
+ "config": {},
678
+ "allow_failure": true,
679
+ "created_automatically": true,
680
+ "is_bulk_action": true,
681
+ "reason": {},
682
+ "condition_id": "string",
683
+ "schedule_id": "string",
684
+ "execution_status": "pending",
685
+ "started_at": "string",
686
+ "updated_at": "string",
687
+ "outputs": {},
688
+ "error_output": {},
689
+ "retry_strategy": "RETRY_AND_RESUME"
690
+ },
691
+ {
692
+ "id": "9ec3711b-db63-449c-b894-54d5bb622a8f",
693
+ "flow_action_id": "9ec3711b-db63-449c-b894-54d5bb622a8f",
694
+ "name": "string",
695
+ "type": "trigger-workflow",
696
+ "config": {},
697
+ "allow_failure": true,
698
+ "created_automatically": true,
699
+ "is_bulk_action": true,
700
+ "reason": {},
701
+ "condition_id": "string",
702
+ "schedule_id": "string",
703
+ "execution_status": "pending",
704
+ "started_at": "string",
705
+ "updated_at": "string",
706
+ "outputs": {},
707
+ "error_output": {},
708
+ "retry_strategy": "RETRY_AND_RESUME"
709
+ }
710
+ ],
711
+ "resume_token": "eyJraWQiOiJrZXkifQ==",
712
+ "trigger_context": {
713
+ "entity_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
714
+ },
715
+ "version": 2,
716
+ "trigger_event": {
717
+ "type": "manual",
718
+ "org_id": "123",
719
+ "entity_id": "e3d3ebac-baab-4395-abf4-50b5bf1f8b74",
720
+ "caller": {
721
+ "EpilotAuth": {}
722
+ }
723
+ },
724
+ "workflow_context": {
725
+ "workflow_exec_id": "string",
726
+ "workflow_exec_task_id": "string",
727
+ "workflow_role": "trigger_workflow",
728
+ "_execution_chain": {
729
+ "parent_execution_id": "string",
730
+ "parent_task_id": "string",
731
+ "depth": 0
732
+ }
733
+ }
734
+ }
735
+ ```
736
+
737
+ </details>
738
+
739
+ ---
740
+
741
+ ### `cancelExecution`
742
+
743
+ Cancel automation execution
744
+
745
+ `DELETE /v1/automation/executions/{execution_id}`
746
+
747
+ ```ts
748
+ const { data } = await client.cancelExecution({
749
+ execution_id: 'example',
750
+ })
751
+ ```
752
+
753
+ <details>
754
+ <summary>Response</summary>
755
+
756
+ ```json
757
+ {
758
+ "id": "9baf184f-bc81-4128-bca3-d974c90a12c4",
759
+ "execution_status": "pending",
760
+ "entity_id": "e3d3ebac-baab-4395-abf4-50b5bf1f8b74",
761
+ "activity_id": "e3d3ebac-baab-4395-abf4-50b5bf1f8b74",
762
+ "entity_snapshot": {
763
+ "_id": "e3d3ebac-baab-4395-abf4-50b5bf1f8b74",
764
+ "_title": "string",
765
+ "_org": "string",
766
+ "_schema": "string",
767
+ "_tags": ["string"],
768
+ "_created_at": "1970-01-01T00:00:00.000Z",
769
+ "_updated_at": "1970-01-01T00:00:00.000Z"
770
+ },
771
+ "org_id": "e3d3ebac-baab-4395-abf4-50b5bf1f8b74",
772
+ "flow_id": "7791b04a-16d2-44a2-9af9-2d59c25c512f",
773
+ "flow_name": "Handle contact form",
774
+ "created_at": "1970-01-01T00:00:00.000Z",
775
+ "updated_at": "1970-01-01T00:00:00.000Z",
776
+ "current_action_id": "9ec3711b-db63-449c-b894-54d5bb622a8f",
777
+ "conditions": [
778
+ {
779
+ "id": "string",
780
+ "schedule_id": "string",
781
+ "evaluationResult": true,
782
+ "statements": []
783
+ }
784
+ ],
785
+ "schedules": [
786
+ {
787
+ "id": "string",
788
+ "scheduleApiId": "string",
789
+ "numberOfUnits": 0,
790
+ "timePeriod": "minutes",
791
+ "timeRelation": "after",
792
+ "source": {}
793
+ }
794
+ ],
795
+ "actions": [
796
+ {
797
+ "id": "9ec3711b-db63-449c-b894-54d5bb622a8f",
798
+ "flow_action_id": "9ec3711b-db63-449c-b894-54d5bb622a8f",
799
+ "name": "string",
800
+ "type": "map-entity",
801
+ "config": {},
802
+ "allow_failure": true,
803
+ "created_automatically": true,
804
+ "is_bulk_action": true,
805
+ "reason": {},
806
+ "condition_id": "string",
807
+ "schedule_id": "string",
808
+ "execution_status": "pending",
809
+ "started_at": "string",
810
+ "updated_at": "string",
811
+ "outputs": {},
812
+ "error_output": {},
813
+ "retry_strategy": "RETRY_AND_RESUME"
814
+ },
815
+ {
816
+ "id": "9ec3711b-db63-449c-b894-54d5bb622a8f",
817
+ "flow_action_id": "9ec3711b-db63-449c-b894-54d5bb622a8f",
818
+ "name": "string",
819
+ "type": "trigger-workflow",
820
+ "config": {},
821
+ "allow_failure": true,
822
+ "created_automatically": true,
823
+ "is_bulk_action": true,
824
+ "reason": {},
825
+ "condition_id": "string",
826
+ "schedule_id": "string",
827
+ "execution_status": "pending",
828
+ "started_at": "string",
829
+ "updated_at": "string",
830
+ "outputs": {},
831
+ "error_output": {},
832
+ "retry_strategy": "RETRY_AND_RESUME"
833
+ }
834
+ ],
835
+ "resume_token": "eyJraWQiOiJrZXkifQ==",
836
+ "trigger_context": {
837
+ "entity_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
838
+ },
839
+ "version": 2,
840
+ "trigger_event": {
841
+ "type": "manual",
842
+ "org_id": "123",
843
+ "entity_id": "e3d3ebac-baab-4395-abf4-50b5bf1f8b74",
844
+ "caller": {
845
+ "EpilotAuth": {}
846
+ }
847
+ },
848
+ "workflow_context": {
849
+ "workflow_exec_id": "string",
850
+ "workflow_exec_task_id": "string",
851
+ "workflow_role": "trigger_workflow",
852
+ "_execution_chain": {
853
+ "parent_execution_id": "string",
854
+ "parent_task_id": "string",
855
+ "depth": 0
856
+ }
857
+ }
858
+ }
859
+ ```
860
+
861
+ </details>
862
+
863
+ ---
864
+
865
+ ### `retriggerAction`
866
+
867
+ Retry a specific automation execution action which failed / is stuck.
868
+
869
+ `POST /v1/automation/executions/{execution_id}/{action_id}/retrigger`
870
+
871
+ ```ts
872
+ const { data } = await client.retriggerAction(
873
+ {
874
+ execution_id: 'example',
875
+ action_id: 'example',
876
+ },
877
+ {
878
+ condition_id: 'string',
879
+ retry_strategy: 'RETRY_AND_RESUME'
880
+ },
881
+ )
882
+ ```
883
+
884
+ ---
885
+
886
+ ### `resumeExecutionWithToken`
887
+
888
+ Resume a paused automation execution using a unique resume token.
889
+
890
+ `POST /v1/automation/public/executions:resume`
891
+
892
+ ```ts
893
+ const { data } = await client.resumeExecutionWithToken(
894
+ null,
895
+ {
896
+ resume_token: 'eyJraWQiOiJrZXkifQ=='
897
+ },
898
+ )
899
+ ```
900
+
901
+ <details>
902
+ <summary>Response</summary>
903
+
904
+ ```json
905
+ {
906
+ "execution": {
907
+ "id": "9baf184f-bc81-4128-bca3-d974c90a12c4",
908
+ "execution_status": "pending",
909
+ "entity_id": "e3d3ebac-baab-4395-abf4-50b5bf1f8b74",
910
+ "activity_id": "e3d3ebac-baab-4395-abf4-50b5bf1f8b74",
911
+ "entity_snapshot": {
912
+ "_id": "e3d3ebac-baab-4395-abf4-50b5bf1f8b74",
913
+ "_title": "string",
914
+ "_org": "string",
915
+ "_schema": "string",
916
+ "_tags": ["string"],
917
+ "_created_at": "1970-01-01T00:00:00.000Z",
918
+ "_updated_at": "1970-01-01T00:00:00.000Z"
919
+ },
920
+ "org_id": "e3d3ebac-baab-4395-abf4-50b5bf1f8b74",
921
+ "flow_id": "7791b04a-16d2-44a2-9af9-2d59c25c512f",
922
+ "flow_name": "Handle contact form",
923
+ "created_at": "1970-01-01T00:00:00.000Z",
924
+ "updated_at": "1970-01-01T00:00:00.000Z",
925
+ "current_action_id": "9ec3711b-db63-449c-b894-54d5bb622a8f",
926
+ "conditions": [
927
+ {}
928
+ ],
929
+ "schedules": [
930
+ {}
931
+ ],
932
+ "actions": [
933
+ {},
934
+ {}
935
+ ],
936
+ "resume_token": "eyJraWQiOiJrZXkifQ==",
937
+ "trigger_context": {
938
+ "entity_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
939
+ },
940
+ "version": 2,
941
+ "trigger_event": {
942
+ "type": "manual",
943
+ "org_id": "123",
944
+ "entity_id": "e3d3ebac-baab-4395-abf4-50b5bf1f8b74",
945
+ "caller": {}
946
+ },
947
+ "workflow_context": {
948
+ "workflow_exec_id": "string",
949
+ "workflow_exec_task_id": "string",
950
+ "workflow_role": "trigger_workflow",
951
+ "_execution_chain": {}
952
+ }
953
+ },
954
+ "resumedAction": {
955
+ "id": "9ec3711b-db63-449c-b894-54d5bb622a8f",
956
+ "flow_action_id": "9ec3711b-db63-449c-b894-54d5bb622a8f",
957
+ "name": "string",
958
+ "type": "map-entity",
959
+ "config": {
960
+ "mapping_config": {},
961
+ "target_schema": "string",
962
+ "target_unique": ["string"],
963
+ "mapping_attributes": [],
964
+ "relation_attributes": [],
965
+ "linkback_relation_attribute": "mapped_entities",
966
+ "linkback_relation_tags": ["string"]
967
+ },
968
+ "allow_failure": true,
969
+ "created_automatically": true,
970
+ "is_bulk_action": true,
971
+ "reason": {
972
+ "message": "There are no registered portal users for the given emails, hence skipping the action",
973
+ "payload": {}
974
+ },
975
+ "condition_id": "string",
976
+ "schedule_id": "string",
977
+ "execution_status": "pending",
978
+ "started_at": "string",
979
+ "updated_at": "string",
980
+ "outputs": {},
981
+ "error_output": {
982
+ "error_code": "MAPPING_ERROR",
983
+ "error_reason": "string",
984
+ "error_info": {}
985
+ },
986
+ "retry_strategy": "RETRY_AND_RESUME"
987
+ }
988
+ }
989
+ ```
990
+
991
+ </details>
992
+
993
+ ---
994
+
995
+ ### `cancelSchedule`
996
+
997
+ Cancel a scheduled automation
998
+
999
+ `DELETE /v1/automation/executions/{execution_id}/schedules/{schedule_id}`
1000
+
1001
+ ```ts
1002
+ const { data } = await client.cancelSchedule({
1003
+ execution_id: 'example',
1004
+ schedule_id: 'example',
1005
+ })
1006
+ ```
1007
+
1008
+ <details>
1009
+ <summary>Response</summary>
1010
+
1011
+ ```json
1012
+ {
1013
+ "id": "string",
1014
+ "scheduleApiId": "string",
1015
+ "numberOfUnits": 0,
1016
+ "timePeriod": "minutes",
1017
+ "timeRelation": "after",
1018
+ "source": {
1019
+ "id": "string",
1020
+ "origin": "trigger",
1021
+ "schema": "string",
1022
+ "attribute": "string"
1023
+ }
1024
+ }
1025
+ ```
1026
+
1027
+ </details>
1028
+
1029
+ ---
1030
+
1031
+ ## Schemas
1032
+
1033
+ ### `AutomationFlowId`
1034
+
1035
+ ID of the Automation Flow
1036
+
1037
+ ```ts
1038
+ type AutomationFlowId = string
1039
+ ```
1040
+
1041
+ ### `AutomationActionId`
1042
+
1043
+ ```ts
1044
+ type AutomationActionId = string
1045
+ ```
1046
+
1047
+ ### `AutomationFlow`
1048
+
1049
+ ```ts
1050
+ type AutomationFlow = {
1051
+ id?: string
1052
+ flow_name: string
1053
+ enabled?: boolean
1054
+ disable_details?: {
1055
+ disabled_at: string // date-time
1056
+ disabled_by: "system" | "user"
1057
+ blame?: string
1058
+ }
1059
+ triggers: Array<{
1060
+ id?: string // uuid
1061
+ type: "frontend_submission"
1062
+ configuration: {
1063
+ source_id?: { ... }
1064
+ }
1065
+ } | {
1066
+ id?: string // uuid
1067
+ type: "journey_submission"
1068
+ configuration: {
1069
+ source_id: { ... }
1070
+ }
1071
+ } | {
1072
+ id?: string // uuid
1073
+ type: "api_submission"
1074
+ configuration: {
1075
+ source_id?: { ... }
1076
+ }
1077
+ } | {
1078
+ id?: string // uuid
1079
+ type: "entity_operation"
1080
+ configuration: {
1081
+ schema?: { ... }
1082
+ operations?: { ... }
1083
+ include_activities?: { ... }
1084
+ exclude_activities?: { ... }
1085
+ filter_config?: { ... }
1086
+ ecp_config?: { ... }
1087
+ }
1088
+ } | {
1089
+ id?: string // uuid
1090
+ type: "activity"
1091
+ configuration: {
1092
+ schema?: { ... }
1093
+ types?: { ... }
1094
+ }
1095
+ } | {
1096
+ id?: string // uuid
1097
+ type: "entity_manual"
1098
+ configuration: {
1099
+ schema?: { ... }
1100
+ }
1101
+ } | {
1102
+ id?: string // uuid
1103
+ type: "received_email"
1104
+ configuration: {
1105
+ message_type?: { ... }
1106
+ }
1107
+ } | {
1108
+ id?: string // uuid
1109
+ type: "new_email_thread"
1110
+ configuration: {
1111
+ shared_inbox_ids?: { ... }
1112
+ direction: { ... }
1113
+ }
1114
+ } | {
1115
+ id?: string // uuid
1116
+ type: "flows_trigger"
1117
+ configuration?: {
1118
+ journey_id?: { ... }
1119
+ }
1120
+ }>
1121
+ trigger_conditions?: Array<{
1122
+ source: string
1123
+ comparison: "equals" | "any_of" | "not_empty" | "is_empty"
1124
+ value?: string | number | string[] | number[]
1125
+ }>
1126
+ entity_schema?: string
1127
+ conditions?: Array<{
1128
+ id?: string
1129
+ schedule_id?: string
1130
+ evaluationResult?: boolean
1131
+ statements?: Array<{
1132
+ id?: { ... }
1133
+ source?: { ... }
1134
+ operation?: { ... }
1135
+ values?: { ... }
1136
+ }>
1137
+ }>
1138
+ schedules?: Array<{
1139
+ id: string
1140
+ scheduleApiId?: string
1141
+ numberOfUnits?: number
1142
+ timePeriod?: "minutes" | "hours" | "days" | "weeks" | "months"
1143
+ timeRelation?: "after" | "before"
1144
+ source: {
1145
+ id: { ... }
1146
+ origin: { ... }
1147
+ schema?: { ... }
1148
+ attribute?: { ... }
1149
+ }
1150
+ // ...
1151
+ }
1152
+ ```
1153
+
1154
+ ### `WorkflowContextRole`
1155
+
1156
+ The role this automation plays in the workflow.
1157
+
1158
+ ```ts
1159
+ type WorkflowContextRole = "trigger_workflow" | "run_task_automation"
1160
+ ```
1161
+
1162
+ ### `SearchAutomationsResp`
1163
+
1164
+ ```ts
1165
+ type SearchAutomationsResp = {
1166
+ total: number
1167
+ results: Array<{
1168
+ id?: string
1169
+ flow_name: string
1170
+ enabled?: boolean
1171
+ disable_details?: {
1172
+ disabled_at: { ... }
1173
+ disabled_by: { ... }
1174
+ blame?: { ... }
1175
+ }
1176
+ triggers: Array<{
1177
+ id?: { ... }
1178
+ type: { ... }
1179
+ configuration: { ... }
1180
+ } | {
1181
+ id?: { ... }
1182
+ type: { ... }
1183
+ configuration: { ... }
1184
+ } | {
1185
+ id?: { ... }
1186
+ type: { ... }
1187
+ configuration: { ... }
1188
+ } | {
1189
+ id?: { ... }
1190
+ type: { ... }
1191
+ configuration: { ... }
1192
+ } | {
1193
+ id?: { ... }
1194
+ type: { ... }
1195
+ configuration: { ... }
1196
+ } | {
1197
+ id?: { ... }
1198
+ type: { ... }
1199
+ configuration: { ... }
1200
+ } | {
1201
+ id?: { ... }
1202
+ type: { ... }
1203
+ configuration: { ... }
1204
+ } | {
1205
+ id?: { ... }
1206
+ type: { ... }
1207
+ configuration: { ... }
1208
+ } | {
1209
+ id?: { ... }
1210
+ type: { ... }
1211
+ configuration?: { ... }
1212
+ }>
1213
+ trigger_conditions?: Array<{
1214
+ source: { ... }
1215
+ comparison: { ... }
1216
+ value?: { ... }
1217
+ }>
1218
+ entity_schema?: string
1219
+ conditions?: Array<{
1220
+ id?: { ... }
1221
+ schedule_id?: { ... }
1222
+ evaluationResult?: { ... }
1223
+ statements?: { ... }
1224
+ }>
1225
+ schedules?: Array<{
1226
+ id: { ... }
1227
+ scheduleApiId?: { ... }
1228
+ numberOfUnits?: { ... }
1229
+ timePeriod?: { ... }
1230
+ timeRelation?: { ... }
1231
+ source: { ... }
1232
+ }>
1233
+ actions: Array<{
1234
+ type?: { ... }
1235
+ config?: { ... }
1236
+ } | {
1237
+ type?: { ... }
1238
+ config?: { ... }
1239
+ } | {
1240
+ type?: { ... }
1241
+ config?: { ... }
1242
+ } | {
1243
+ type?: { ... }
1244
+ config?: { ... }
1245
+ } | {
1246
+ type?: { ... }
1247
+ config?: { ... }
1248
+ } | {
1249
+ type?: { ... }
1250
+ config?: { ... }
1251
+ } | {
1252
+ type?: { ... }
1253
+ config?: { ... }
1254
+ } | {
1255
+ type?: { ... }
1256
+ config?: { ... }
1257
+ } | {
1258
+ type?: { ... }
1259
+ config?: { ... }
1260
+ } | {
1261
+ type?: { ... }
1262
+ config?: { ... }
1263
+ } | {
1264
+ id?: { ... }
1265
+ // ...
1266
+ }
1267
+ ```
1268
+
1269
+ ### `AnyTrigger`
1270
+
1271
+ ```ts
1272
+ type AnyTrigger = {
1273
+ id?: string // uuid
1274
+ type: "frontend_submission"
1275
+ configuration: {
1276
+ source_id?: string
1277
+ }
1278
+ } | {
1279
+ id?: string // uuid
1280
+ type: "journey_submission"
1281
+ configuration: {
1282
+ source_id: string // uuid
1283
+ }
1284
+ } | {
1285
+ id?: string // uuid
1286
+ type: "api_submission"
1287
+ configuration: {
1288
+ source_id?: string
1289
+ }
1290
+ } | {
1291
+ id?: string // uuid
1292
+ type: "entity_operation"
1293
+ configuration: {
1294
+ schema?: string
1295
+ operations?: "createEntity" | "updateEntity" | "deleteEntity" | "softDeleteEntity" | "restoreEntity"[]
1296
+ include_activities?: string[]
1297
+ exclude_activities?: string[]
1298
+ filter_config?: {
1299
+ operation?: { ... }
1300
+ activity?: { ... }
1301
+ }
1302
+ ecp_config?: {
1303
+ origin?: { ... }
1304
+ portal_id?: { ... }
1305
+ file_config?: { ... }
1306
+ }
1307
+ }
1308
+ } | {
1309
+ id?: string // uuid
1310
+ type: "activity"
1311
+ configuration: {
1312
+ schema?: string
1313
+ types?: "CreateMeterReading" | "UpdateMeterReading" | "DocDownloadedFromPortal" | "PortalUserResetPassword" | "PortalUserResetForgotPassword" | "SelfAssignmentFromPortal" | string[]
1314
+ }
1315
+ } | {
1316
+ id?: string // uuid
1317
+ type: "entity_manual"
1318
+ configuration: {
1319
+ schema?: string
1320
+ }
1321
+ } | {
1322
+ id?: string // uuid
1323
+ type: "received_email"
1324
+ configuration: {
1325
+ message_type?: "RECEIVED"
1326
+ }
1327
+ } | {
1328
+ id?: string // uuid
1329
+ type: "new_email_thread"
1330
+ configuration: {
1331
+ shared_inbox_ids?: string[]
1332
+ direction: "INBOUND" | "OUTBOUND" | "BOTH"
1333
+ }
1334
+ } | {
1335
+ id?: string // uuid
1336
+ type: "flows_trigger"
1337
+ configuration?: {
1338
+ journey_id?: string // uuid
1339
+ }
1340
+ }
1341
+ ```
1342
+
1343
+ ### `AnyAction`
1344
+
1345
+ ```ts
1346
+ type AnyAction = {
1347
+ type?: "map-entity"
1348
+ config?: {
1349
+ mapping_config?: {
1350
+ config_id: { ... }
1351
+ target_id: { ... }
1352
+ version?: { ... }
1353
+ }
1354
+ target_schema: string
1355
+ target_unique?: string[]
1356
+ mapping_attributes?: Array<{
1357
+ target?: { ... }
1358
+ operation: { ... }
1359
+ } | {
1360
+ mode: { ... }
1361
+ target: { ... }
1362
+ value: { ... }
1363
+ } | {
1364
+ mode: { ... }
1365
+ target: { ... }
1366
+ source: { ... }
1367
+ } | {
1368
+ mode: { ... }
1369
+ target: { ... }
1370
+ source?: { ... }
1371
+ value_json: { ... }
1372
+ target_unique?: { ... }
1373
+ }>
1374
+ relation_attributes?: Array<{
1375
+ target: { ... }
1376
+ target_tags?: { ... }
1377
+ target_tags_include_source?: { ... }
1378
+ source_filter?: { ... }
1379
+ related_to?: { ... }
1380
+ mode: { ... }
1381
+ }>
1382
+ linkback_relation_attribute?: string
1383
+ linkback_relation_tags?: string[]
1384
+ }
1385
+ } | {
1386
+ type?: "trigger-workflow"
1387
+ config?: {
1388
+ target_workflow?: string
1389
+ conditions?: Array<{
1390
+ source: { ... }
1391
+ comparison: { ... }
1392
+ value?: { ... }
1393
+ schema?: { ... }
1394
+ }>
1395
+ assignees?: string[]
1396
+ assign_steps?: Array<{
1397
+ step_id?: { ... }
1398
+ step_name?: { ... }
1399
+ user_ids?: { ... }
1400
+ }>
1401
+ filter_with_purposes?: boolean
1402
+ }
1403
+ } | {
1404
+ type?: "trigger-share-entity"
1405
+ config?: {
1406
+ partner_org_ids?: string[]
1407
+ }
1408
+ } | {
1409
+ type?: "trigger-webhook"
1410
+ config?: {
1411
+ event_id?: string
1412
+ entity_sources?: string[]
1413
+ target_webhook_id?: string
1414
+ sync?: boolean
1415
+ }
1416
+ } | {
1417
+ type?: "inform-erp"
1418
+ config?: {
1419
+ entity_sources?: string[]
1420
+ target_webhook_id?: string
1421
+ sync?: boolean
1422
+ }
1423
+ } | {
1424
+ type?: "trigger-event"
1425
+ config?: {
1426
+ event_name: string
1427
+ event_inputs?: Record<string, unknown>
1428
+ }
1429
+ } | {
1430
+ type?: "create-document"
1431
+ config?: {
1432
+ template_id?: string
1433
+ filename?: string
1434
+ }
1435
+ } | {
1436
+ type?: "send-email"
1437
+ config?: {
1438
+ email_template_id?: string
1439
+ language_code?: "de" | "en"
1440
+ notify_portal_user_only?: boolean
1441
+ skip_creating_entities?: boolean
1442
+ wait_for_confirmation?: boolean
1443
+ attachments?: Array<{
1444
+ source_filter?: { ... }
1445
+ }>
1446
+ // ...
1447
+ }
1448
+ ```
1449
+
1450
+ ### `AnyActionConfig`
1451
+
1452
+ ```ts
1453
+ type AnyActionConfig = {
1454
+ id?: string
1455
+ flow_action_id?: string
1456
+ name?: string
1457
+ type?: "map-entity"
1458
+ config?: {
1459
+ mapping_config?: {
1460
+ config_id: { ... }
1461
+ target_id: { ... }
1462
+ version?: { ... }
1463
+ }
1464
+ target_schema: string
1465
+ target_unique?: string[]
1466
+ mapping_attributes?: Array<{
1467
+ target?: { ... }
1468
+ operation: { ... }
1469
+ } | {
1470
+ mode: { ... }
1471
+ target: { ... }
1472
+ value: { ... }
1473
+ } | {
1474
+ mode: { ... }
1475
+ target: { ... }
1476
+ source: { ... }
1477
+ } | {
1478
+ mode: { ... }
1479
+ target: { ... }
1480
+ source?: { ... }
1481
+ value_json: { ... }
1482
+ target_unique?: { ... }
1483
+ }>
1484
+ relation_attributes?: Array<{
1485
+ target: { ... }
1486
+ target_tags?: { ... }
1487
+ target_tags_include_source?: { ... }
1488
+ source_filter?: { ... }
1489
+ related_to?: { ... }
1490
+ mode: { ... }
1491
+ }>
1492
+ linkback_relation_attribute?: string
1493
+ linkback_relation_tags?: string[]
1494
+ }
1495
+ allow_failure?: boolean
1496
+ created_automatically?: boolean
1497
+ is_bulk_action?: boolean
1498
+ reason?: {
1499
+ message?: string
1500
+ payload?: Record<string, unknown>
1501
+ }
1502
+ condition_id?: string
1503
+ schedule_id?: string
1504
+ } | {
1505
+ id?: string
1506
+ flow_action_id?: string
1507
+ name?: string
1508
+ type?: "trigger-workflow"
1509
+ config?: {
1510
+ target_workflow?: string
1511
+ conditions?: Array<{
1512
+ source: { ... }
1513
+ comparison: { ... }
1514
+ value?: { ... }
1515
+ schema?: { ... }
1516
+ }>
1517
+ assignees?: string[]
1518
+ assign_steps?: Array<{
1519
+ step_id?: { ... }
1520
+ step_name?: { ... }
1521
+ user_ids?: { ... }
1522
+ }>
1523
+ filter_with_purposes?: boolean
1524
+ }
1525
+ allow_failure?: boolean
1526
+ created_automatically?: boolean
1527
+ is_bulk_action?: boolean
1528
+ reason?: {
1529
+ message?: string
1530
+ payload?: Record<string, unknown>
1531
+ }
1532
+ condition_id?: string
1533
+ schedule_id?: string
1534
+ } | {
1535
+ id?: string
1536
+ flow_action_id?: string
1537
+ name?: string
1538
+ type?: "trigger-workflow"
1539
+ config?: {
1540
+ partner_org_ids?: string[]
1541
+ }
1542
+ allow_failure?: boolean
1543
+ created_automatically?: boolean
1544
+ is_bulk_action?: boolean
1545
+ reason?: {
1546
+ message?: string
1547
+ payload?: Record<string, unknown>
1548
+ }
1549
+ condition_id?: string
1550
+ schedule_id?: string
1551
+ } | {
1552
+ id?: string
1553
+ // ...
1554
+ }
1555
+ ```
1556
+
1557
+ ### `AutomationActionConfig`
1558
+
1559
+ ```ts
1560
+ type AutomationActionConfig = {
1561
+ id?: string
1562
+ flow_action_id?: string
1563
+ name?: string
1564
+ type?: string
1565
+ config?: Record<string, unknown>
1566
+ allow_failure?: boolean
1567
+ created_automatically?: boolean
1568
+ is_bulk_action?: boolean
1569
+ reason?: {
1570
+ message?: string
1571
+ payload?: Record<string, unknown>
1572
+ }
1573
+ condition_id?: string
1574
+ schedule_id?: string
1575
+ }
1576
+ ```
1577
+
1578
+ ### `AutomationActionExecutionState`
1579
+
1580
+ ```ts
1581
+ type AutomationActionExecutionState = {
1582
+ execution_status?: "pending" | "starting" | "in_progress" | "paused" | "success" | "failed" | "cancelled" | "skipped" | "scheduled" | "hot"
1583
+ started_at?: string
1584
+ updated_at?: string
1585
+ outputs?: Record<string, unknown>
1586
+ error_output?: {
1587
+ error_code: "MAPPING_ERROR" | "REFRESH_RELATIONS_ERROR" | "DUPLICATE_ENTITY_ERROR" | "TRIGGER_WORKFLOW_ERROR" | "TIMEOUT_ERROR" | "BAD_CONFIG" | "INTERNAL_ERROR" | "TRIGGER_WEBHOOK_ERROR" | "TEMPLATE_ERROR" | "INVALID_PAYLOAD" | "INVALID_SCHEDULE_CONFIG" | "CUSTOM_ACTION_ERROR" | "ORDER_CREATION_ERROR" | "DOCUMENT_GENERATION_ERROR" | "BULK_EMAIL_ERROR" | "SHARING_ERROR" | "CANCEL_FLOW_EXECUTION_ERROR" | "METER_READING_NOT_FOUND" | "ENTITY_NOT_FOUND"
1588
+ error_reason: string
1589
+ error_info?: {
1590
+ details?: { ... }
1591
+ }
1592
+ }
1593
+ retry_strategy?: "RETRY_AND_RESUME" | "RETRY_AND_STOP" | "RETRY_ALL_PARENT_CONDITION_ACTIONS"
1594
+ }
1595
+ ```
1596
+
1597
+ ### `RetryStrategy`
1598
+
1599
+ different behaviors for retrying failed execution actions.
1600
+
1601
+ ```ts
1602
+ type RetryStrategy = "RETRY_AND_RESUME" | "RETRY_AND_STOP" | "RETRY_ALL_PARENT_CONDITION_ACTIONS"
1603
+ ```
1604
+
1605
+ ### `AutomationAction`
1606
+
1607
+ ```ts
1608
+ type AutomationAction = {
1609
+ id?: string
1610
+ flow_action_id?: string
1611
+ name?: string
1612
+ type?: string
1613
+ config?: Record<string, unknown>
1614
+ allow_failure?: boolean
1615
+ created_automatically?: boolean
1616
+ is_bulk_action?: boolean
1617
+ reason?: {
1618
+ message?: string
1619
+ payload?: Record<string, unknown>
1620
+ }
1621
+ condition_id?: string
1622
+ schedule_id?: string
1623
+ execution_status?: "pending" | "starting" | "in_progress" | "paused" | "success" | "failed" | "cancelled" | "skipped" | "scheduled" | "hot"
1624
+ started_at?: string
1625
+ updated_at?: string
1626
+ outputs?: Record<string, unknown>
1627
+ error_output?: {
1628
+ error_code: "MAPPING_ERROR" | "REFRESH_RELATIONS_ERROR" | "DUPLICATE_ENTITY_ERROR" | "TRIGGER_WORKFLOW_ERROR" | "TIMEOUT_ERROR" | "BAD_CONFIG" | "INTERNAL_ERROR" | "TRIGGER_WEBHOOK_ERROR" | "TEMPLATE_ERROR" | "INVALID_PAYLOAD" | "INVALID_SCHEDULE_CONFIG" | "CUSTOM_ACTION_ERROR" | "ORDER_CREATION_ERROR" | "DOCUMENT_GENERATION_ERROR" | "BULK_EMAIL_ERROR" | "SHARING_ERROR" | "CANCEL_FLOW_EXECUTION_ERROR" | "METER_READING_NOT_FOUND" | "ENTITY_NOT_FOUND"
1629
+ error_reason: string
1630
+ error_info?: {
1631
+ details?: { ... }
1632
+ }
1633
+ }
1634
+ retry_strategy?: "RETRY_AND_RESUME" | "RETRY_AND_STOP" | "RETRY_ALL_PARENT_CONDITION_ACTIONS"
1635
+ }
1636
+ ```
1637
+
1638
+ ### `ErrorOutput`
1639
+
1640
+ ```ts
1641
+ type ErrorOutput = {
1642
+ error_code: "MAPPING_ERROR" | "REFRESH_RELATIONS_ERROR" | "DUPLICATE_ENTITY_ERROR" | "TRIGGER_WORKFLOW_ERROR" | "TIMEOUT_ERROR" | "BAD_CONFIG" | "INTERNAL_ERROR" | "TRIGGER_WEBHOOK_ERROR" | "TEMPLATE_ERROR" | "INVALID_PAYLOAD" | "INVALID_SCHEDULE_CONFIG" | "CUSTOM_ACTION_ERROR" | "ORDER_CREATION_ERROR" | "DOCUMENT_GENERATION_ERROR" | "BULK_EMAIL_ERROR" | "SHARING_ERROR" | "CANCEL_FLOW_EXECUTION_ERROR" | "METER_READING_NOT_FOUND" | "ENTITY_NOT_FOUND"
1643
+ error_reason: string
1644
+ error_info?: {
1645
+ details?: Array<{
1646
+ explanation: { ... }
1647
+ context?: { ... }
1648
+ id?: { ... }
1649
+ }>
1650
+ }
1651
+ }
1652
+ ```
1653
+
1654
+ ### `ErrorCode`
1655
+
1656
+ ```ts
1657
+ type ErrorCode = "MAPPING_ERROR" | "REFRESH_RELATIONS_ERROR" | "DUPLICATE_ENTITY_ERROR" | "TRIGGER_WORKFLOW_ERROR" | "TIMEOUT_ERROR" | "BAD_CONFIG" | "INTERNAL_ERROR" | "TRIGGER_WEBHOOK_ERROR" | "TEMPLATE_ERROR" | "INVALID_PAYLOAD" | "INVALID_SCHEDULE_CONFIG" | "CUSTOM_ACTION_ERROR" | "ORDER_CREATION_ERROR" | "DOCUMENT_GENERATION_ERROR" | "BULK_EMAIL_ERROR" | "SHARING_ERROR" | "CANCEL_FLOW_EXECUTION_ERROR" | "METER_READING_NOT_FOUND" | "ENTITY_NOT_FOUND"
1658
+ ```
1659
+
1660
+ ### `ErrorDetail`
1661
+
1662
+ ```ts
1663
+ type ErrorDetail = {
1664
+ explanation: string
1665
+ context?: string
1666
+ id?: string
1667
+ }
1668
+ ```
1669
+
1670
+ ### `CartCheckoutActionConfig`
1671
+
1672
+ ```ts
1673
+ type CartCheckoutActionConfig = {
1674
+ id?: string
1675
+ flow_action_id?: string
1676
+ name?: string
1677
+ type?: "cart-checkout"
1678
+ config?: {
1679
+ version?: string
1680
+ mapping_config?: {
1681
+ config_id: { ... }
1682
+ target_id: { ... }
1683
+ version?: { ... }
1684
+ }
1685
+ relation_attributes?: Array<{
1686
+ target: { ... }
1687
+ target_tags?: { ... }
1688
+ target_tags_include_source?: { ... }
1689
+ source_filter?: { ... }
1690
+ related_to?: { ... }
1691
+ mode: { ... }
1692
+ }>
1693
+ mapping_attributes?: Array<{
1694
+ target?: { ... }
1695
+ operation: { ... }
1696
+ } | {
1697
+ mode: { ... }
1698
+ target: { ... }
1699
+ value: { ... }
1700
+ } | {
1701
+ mode: { ... }
1702
+ target: { ... }
1703
+ source: { ... }
1704
+ } | {
1705
+ mode: { ... }
1706
+ target: { ... }
1707
+ source?: { ... }
1708
+ value_json: { ... }
1709
+ target_unique?: { ... }
1710
+ }>
1711
+ linkback_relation_attribute?: string
1712
+ linkback_relation_tags?: string[]
1713
+ target_unique?: string[]
1714
+ }
1715
+ allow_failure?: boolean
1716
+ created_automatically?: boolean
1717
+ is_bulk_action?: boolean
1718
+ reason?: {
1719
+ message?: string
1720
+ payload?: Record<string, unknown>
1721
+ }
1722
+ condition_id?: string
1723
+ schedule_id?: string
1724
+ }
1725
+ ```
1726
+
1727
+ ### `CartCheckoutAction`
1728
+
1729
+ ```ts
1730
+ type CartCheckoutAction = {
1731
+ type?: "cart-checkout"
1732
+ config?: {
1733
+ version?: string
1734
+ mapping_config?: {
1735
+ config_id: { ... }
1736
+ target_id: { ... }
1737
+ version?: { ... }
1738
+ }
1739
+ relation_attributes?: Array<{
1740
+ target: { ... }
1741
+ target_tags?: { ... }
1742
+ target_tags_include_source?: { ... }
1743
+ source_filter?: { ... }
1744
+ related_to?: { ... }
1745
+ mode: { ... }
1746
+ }>
1747
+ mapping_attributes?: Array<{
1748
+ target?: { ... }
1749
+ operation: { ... }
1750
+ } | {
1751
+ mode: { ... }
1752
+ target: { ... }
1753
+ value: { ... }
1754
+ } | {
1755
+ mode: { ... }
1756
+ target: { ... }
1757
+ source: { ... }
1758
+ } | {
1759
+ mode: { ... }
1760
+ target: { ... }
1761
+ source?: { ... }
1762
+ value_json: { ... }
1763
+ target_unique?: { ... }
1764
+ }>
1765
+ linkback_relation_attribute?: string
1766
+ linkback_relation_tags?: string[]
1767
+ target_unique?: string[]
1768
+ }
1769
+ }
1770
+ ```
1771
+
1772
+ ### `CartCheckoutConfig`
1773
+
1774
+ ```ts
1775
+ type CartCheckoutConfig = {
1776
+ version?: string
1777
+ mapping_config?: {
1778
+ config_id: string
1779
+ target_id: string
1780
+ version?: number
1781
+ }
1782
+ relation_attributes?: Array<{
1783
+ target: string
1784
+ target_tags?: string[]
1785
+ target_tags_include_source?: boolean
1786
+ source_filter?: {
1787
+ limit?: { ... }
1788
+ schema?: { ... }
1789
+ attribute?: { ... }
1790
+ relation_tag?: { ... }
1791
+ tag?: { ... }
1792
+ self?: { ... }
1793
+ }
1794
+ related_to?: Record<string, unknown>
1795
+ mode: "append" | "prepend" | "set"
1796
+ }>
1797
+ mapping_attributes?: Array<{
1798
+ target?: string
1799
+ operation: {
1800
+ _set?: { ... }
1801
+ _append?: { ... }
1802
+ _uniq?: { ... }
1803
+ _copy?: { ... }
1804
+ } | unknown
1805
+ } | {
1806
+ mode: "copy_if_exists" | "append_if_exists" | "set_value"
1807
+ target: string
1808
+ value: unknown
1809
+ } | {
1810
+ mode: "copy_if_exists" | "append_if_exists" | "set_value"
1811
+ target: string
1812
+ source: string
1813
+ } | {
1814
+ mode: "copy_if_exists" | "append_if_exists" | "set_value"
1815
+ target: string
1816
+ source?: string
1817
+ value_json: string
1818
+ target_unique?: string[]
1819
+ }>
1820
+ linkback_relation_attribute?: string
1821
+ linkback_relation_tags?: string[]
1822
+ target_unique?: string[]
1823
+ }
1824
+ ```
1825
+
1826
+ ### `MapEntityActionConfig`
1827
+
1828
+ ```ts
1829
+ type MapEntityActionConfig = {
1830
+ id?: string
1831
+ flow_action_id?: string
1832
+ name?: string
1833
+ type?: "map-entity"
1834
+ config?: {
1835
+ mapping_config?: {
1836
+ config_id: { ... }
1837
+ target_id: { ... }
1838
+ version?: { ... }
1839
+ }
1840
+ target_schema: string
1841
+ target_unique?: string[]
1842
+ mapping_attributes?: Array<{
1843
+ target?: { ... }
1844
+ operation: { ... }
1845
+ } | {
1846
+ mode: { ... }
1847
+ target: { ... }
1848
+ value: { ... }
1849
+ } | {
1850
+ mode: { ... }
1851
+ target: { ... }
1852
+ source: { ... }
1853
+ } | {
1854
+ mode: { ... }
1855
+ target: { ... }
1856
+ source?: { ... }
1857
+ value_json: { ... }
1858
+ target_unique?: { ... }
1859
+ }>
1860
+ relation_attributes?: Array<{
1861
+ target: { ... }
1862
+ target_tags?: { ... }
1863
+ target_tags_include_source?: { ... }
1864
+ source_filter?: { ... }
1865
+ related_to?: { ... }
1866
+ mode: { ... }
1867
+ }>
1868
+ linkback_relation_attribute?: string
1869
+ linkback_relation_tags?: string[]
1870
+ }
1871
+ allow_failure?: boolean
1872
+ created_automatically?: boolean
1873
+ is_bulk_action?: boolean
1874
+ reason?: {
1875
+ message?: string
1876
+ payload?: Record<string, unknown>
1877
+ }
1878
+ condition_id?: string
1879
+ schedule_id?: string
1880
+ }
1881
+ ```
1882
+
1883
+ ### `MapEntityAction`
1884
+
1885
+ ```ts
1886
+ type MapEntityAction = {
1887
+ type?: "map-entity"
1888
+ config?: {
1889
+ mapping_config?: {
1890
+ config_id: { ... }
1891
+ target_id: { ... }
1892
+ version?: { ... }
1893
+ }
1894
+ target_schema: string
1895
+ target_unique?: string[]
1896
+ mapping_attributes?: Array<{
1897
+ target?: { ... }
1898
+ operation: { ... }
1899
+ } | {
1900
+ mode: { ... }
1901
+ target: { ... }
1902
+ value: { ... }
1903
+ } | {
1904
+ mode: { ... }
1905
+ target: { ... }
1906
+ source: { ... }
1907
+ } | {
1908
+ mode: { ... }
1909
+ target: { ... }
1910
+ source?: { ... }
1911
+ value_json: { ... }
1912
+ target_unique?: { ... }
1913
+ }>
1914
+ relation_attributes?: Array<{
1915
+ target: { ... }
1916
+ target_tags?: { ... }
1917
+ target_tags_include_source?: { ... }
1918
+ source_filter?: { ... }
1919
+ related_to?: { ... }
1920
+ mode: { ... }
1921
+ }>
1922
+ linkback_relation_attribute?: string
1923
+ linkback_relation_tags?: string[]
1924
+ }
1925
+ }
1926
+ ```
1927
+
1928
+ ### `MapEntityConfig`
1929
+
1930
+ ```ts
1931
+ type MapEntityConfig = {
1932
+ mapping_config?: {
1933
+ config_id: string
1934
+ target_id: string
1935
+ version?: number
1936
+ }
1937
+ target_schema: string
1938
+ target_unique?: string[]
1939
+ mapping_attributes?: Array<{
1940
+ target?: string
1941
+ operation: {
1942
+ _set?: { ... }
1943
+ _append?: { ... }
1944
+ _uniq?: { ... }
1945
+ _copy?: { ... }
1946
+ } | unknown
1947
+ } | {
1948
+ mode: "copy_if_exists" | "append_if_exists" | "set_value"
1949
+ target: string
1950
+ value: unknown
1951
+ } | {
1952
+ mode: "copy_if_exists" | "append_if_exists" | "set_value"
1953
+ target: string
1954
+ source: string
1955
+ } | {
1956
+ mode: "copy_if_exists" | "append_if_exists" | "set_value"
1957
+ target: string
1958
+ source?: string
1959
+ value_json: string
1960
+ target_unique?: string[]
1961
+ }>
1962
+ relation_attributes?: Array<{
1963
+ target: string
1964
+ target_tags?: string[]
1965
+ target_tags_include_source?: boolean
1966
+ source_filter?: {
1967
+ limit?: { ... }
1968
+ schema?: { ... }
1969
+ attribute?: { ... }
1970
+ relation_tag?: { ... }
1971
+ tag?: { ... }
1972
+ self?: { ... }
1973
+ }
1974
+ related_to?: Record<string, unknown>
1975
+ mode: "append" | "prepend" | "set"
1976
+ }>
1977
+ linkback_relation_attribute?: string
1978
+ linkback_relation_tags?: string[]
1979
+ }
1980
+ ```
1981
+
1982
+ ### `MappingConfigRef`
1983
+
1984
+ ```ts
1985
+ type MappingConfigRef = {
1986
+ config_id: string
1987
+ target_id: string
1988
+ version?: number
1989
+ }
1990
+ ```
1991
+
1992
+ ### `RelationAttribute`
1993
+
1994
+ ```ts
1995
+ type RelationAttribute = {
1996
+ target: string
1997
+ target_tags?: string[]
1998
+ target_tags_include_source?: boolean
1999
+ source_filter?: {
2000
+ limit?: number
2001
+ schema?: string
2002
+ attribute?: string
2003
+ relation_tag?: string
2004
+ tag?: string
2005
+ self?: boolean
2006
+ }
2007
+ related_to?: Record<string, unknown>
2008
+ mode: "append" | "prepend" | "set"
2009
+ }
2010
+ ```
2011
+
2012
+ ### `MappingAttributeV2`
2013
+
2014
+ ```ts
2015
+ type MappingAttributeV2 = {
2016
+ target?: string
2017
+ operation: {
2018
+ _set?: unknown
2019
+ _append?: unknown
2020
+ _uniq?: boolean | string[]
2021
+ _copy?: string
2022
+ } | unknown
2023
+ }
2024
+ ```
2025
+
2026
+ ### `OperationNode`
2027
+
2028
+ Mapping operation nodes are either primitive values or operation node objects
2029
+
2030
+ ```ts
2031
+ type OperationNode = {
2032
+ _set?: unknown
2033
+ _append?: unknown
2034
+ _uniq?: boolean | string[]
2035
+ _copy?: string
2036
+ } | unknown
2037
+ ```
2038
+
2039
+ ### `OperationObjectNode`
2040
+
2041
+ ```ts
2042
+ type OperationObjectNode = {
2043
+ _set?: unknown
2044
+ _append?: unknown
2045
+ _uniq?: boolean | string[]
2046
+ _copy?: string
2047
+ }
2048
+ ```
2049
+
2050
+ ### `PrimitiveJSONValue`
2051
+
2052
+ ```ts
2053
+ type PrimitiveJSONValue = unknown
2054
+ ```
2055
+
2056
+ ### `MappingAttribute`
2057
+
2058
+ ```ts
2059
+ type MappingAttribute = {
2060
+ mode: "copy_if_exists" | "append_if_exists" | "set_value"
2061
+ target: string
2062
+ value: unknown
2063
+ } | {
2064
+ mode: "copy_if_exists" | "append_if_exists" | "set_value"
2065
+ target: string
2066
+ source: string
2067
+ } | {
2068
+ mode: "copy_if_exists" | "append_if_exists" | "set_value"
2069
+ target: string
2070
+ source?: string
2071
+ value_json: string
2072
+ target_unique?: string[]
2073
+ }
2074
+ ```
2075
+
2076
+ ### `MappingAttributeMode`
2077
+
2078
+ - copy_if_exists - it replaces the target attribute with the source value - append_if_exists - it currently replaces target attribute with array like values. Useful when you have multiple values to be added into one attribute. - set_value - it sets a value to a predefined value. Must be used togethe
2079
+
2080
+ ```ts
2081
+ type MappingAttributeMode = "copy_if_exists" | "append_if_exists" | "set_value"
2082
+ ```
2083
+
2084
+ ### `SetValueMapper`
2085
+
2086
+ ```ts
2087
+ type SetValueMapper = {
2088
+ mode: "copy_if_exists" | "append_if_exists" | "set_value"
2089
+ target: string
2090
+ value: unknown
2091
+ }
2092
+ ```
2093
+
2094
+ ### `CopyValueMapper`
2095
+
2096
+ ```ts
2097
+ type CopyValueMapper = {
2098
+ mode: "copy_if_exists" | "append_if_exists" | "set_value"
2099
+ target: string
2100
+ source: string
2101
+ }
2102
+ ```
2103
+
2104
+ ### `AppendValueMapper`
2105
+
2106
+ ```ts
2107
+ type AppendValueMapper = {
2108
+ mode: "copy_if_exists" | "append_if_exists" | "set_value"
2109
+ target: string
2110
+ source?: string
2111
+ value_json: string
2112
+ target_unique?: string[]
2113
+ }
2114
+ ```
2115
+
2116
+ ### `MoveThreadAction`
2117
+
2118
+ ```ts
2119
+ type MoveThreadAction = {
2120
+ type?: "move-thread"
2121
+ config?: {
2122
+ target_inbox_id?: string
2123
+ }
2124
+ }
2125
+ ```
2126
+
2127
+ ### `AssignThreadAction`
2128
+
2129
+ ```ts
2130
+ type AssignThreadAction = {
2131
+ type?: "assign-thread"
2132
+ config?: {
2133
+ remove?: string[]
2134
+ add?: string[]
2135
+ }
2136
+ }
2137
+ ```
2138
+
2139
+ ### `MoveThreadConfig`
2140
+
2141
+ ```ts
2142
+ type MoveThreadConfig = {
2143
+ target_inbox_id?: string
2144
+ }
2145
+ ```
2146
+
2147
+ ### `AssignThreadConfig`
2148
+
2149
+ ```ts
2150
+ type AssignThreadConfig = {
2151
+ remove?: string[]
2152
+ add?: string[]
2153
+ }
2154
+ ```
2155
+
2156
+ ### `SendEmailActionConfig`
2157
+
2158
+ ```ts
2159
+ type SendEmailActionConfig = {
2160
+ id?: string
2161
+ flow_action_id?: string
2162
+ name?: string
2163
+ type?: "send-email"
2164
+ config?: {
2165
+ email_template_id?: string
2166
+ language_code?: "de" | "en"
2167
+ notify_portal_user_only?: boolean
2168
+ skip_creating_entities?: boolean
2169
+ wait_for_confirmation?: boolean
2170
+ attachments?: Array<{
2171
+ source_filter?: { ... }
2172
+ }>
2173
+ conditions?: Array<{
2174
+ _equals?: { ... }
2175
+ }>
2176
+ }
2177
+ allow_failure?: boolean
2178
+ created_automatically?: boolean
2179
+ is_bulk_action?: boolean
2180
+ reason?: {
2181
+ message?: string
2182
+ payload?: Record<string, unknown>
2183
+ }
2184
+ condition_id?: string
2185
+ schedule_id?: string
2186
+ }
2187
+ ```
2188
+
2189
+ ### `SendEmailAction`
2190
+
2191
+ ```ts
2192
+ type SendEmailAction = {
2193
+ type?: "send-email"
2194
+ config?: {
2195
+ email_template_id?: string
2196
+ language_code?: "de" | "en"
2197
+ notify_portal_user_only?: boolean
2198
+ skip_creating_entities?: boolean
2199
+ wait_for_confirmation?: boolean
2200
+ attachments?: Array<{
2201
+ source_filter?: { ... }
2202
+ }>
2203
+ conditions?: Array<{
2204
+ _equals?: { ... }
2205
+ }>
2206
+ }
2207
+ }
2208
+ ```
2209
+
2210
+ ### `SendEmailConfig`
2211
+
2212
+ ```ts
2213
+ type SendEmailConfig = {
2214
+ email_template_id?: string
2215
+ language_code?: "de" | "en"
2216
+ notify_portal_user_only?: boolean
2217
+ skip_creating_entities?: boolean
2218
+ wait_for_confirmation?: boolean
2219
+ attachments?: Array<{
2220
+ source_filter?: {
2221
+ limit?: { ... }
2222
+ filename_regex?: { ... }
2223
+ attribute?: { ... }
2224
+ relation_tag?: { ... }
2225
+ tag?: { ... }
2226
+ document_type?: { ... }
2227
+ self?: { ... }
2228
+ }
2229
+ }>
2230
+ conditions?: Array<{
2231
+ _equals?: {
2232
+ source?: { ... }
2233
+ value?: { ... }
2234
+ }
2235
+ }>
2236
+ }
2237
+ ```
2238
+
2239
+ ### `SendEmailCondition`
2240
+
2241
+ ```ts
2242
+ type SendEmailCondition = {
2243
+ _equals?: {
2244
+ source?: string
2245
+ value?: string
2246
+ }
2247
+ }
2248
+ ```
2249
+
2250
+ ### `CreateDocumentActionConfig`
2251
+
2252
+ ```ts
2253
+ type CreateDocumentActionConfig = {
2254
+ id?: string
2255
+ flow_action_id?: string
2256
+ name?: string
2257
+ type?: "create-document"
2258
+ config?: {
2259
+ template_id?: string
2260
+ filename?: string
2261
+ }
2262
+ allow_failure?: boolean
2263
+ created_automatically?: boolean
2264
+ is_bulk_action?: boolean
2265
+ reason?: {
2266
+ message?: string
2267
+ payload?: Record<string, unknown>
2268
+ }
2269
+ condition_id?: string
2270
+ schedule_id?: string
2271
+ }
2272
+ ```
2273
+
2274
+ ### `CreateDocumentAction`
2275
+
2276
+ ```ts
2277
+ type CreateDocumentAction = {
2278
+ type?: "create-document"
2279
+ config?: {
2280
+ template_id?: string
2281
+ filename?: string
2282
+ }
2283
+ }
2284
+ ```
2285
+
2286
+ ### `CreateDocumentConfig`
2287
+
2288
+ ```ts
2289
+ type CreateDocumentConfig = {
2290
+ template_id?: string
2291
+ filename?: string
2292
+ }
2293
+ ```
2294
+
2295
+ ### `TriggerWorkflowActionConfig`
2296
+
2297
+ ```ts
2298
+ type TriggerWorkflowActionConfig = {
2299
+ id?: string
2300
+ flow_action_id?: string
2301
+ name?: string
2302
+ type?: "trigger-workflow"
2303
+ config?: {
2304
+ target_workflow?: string
2305
+ conditions?: Array<{
2306
+ source: { ... }
2307
+ comparison: { ... }
2308
+ value?: { ... }
2309
+ schema?: { ... }
2310
+ }>
2311
+ assignees?: string[]
2312
+ assign_steps?: Array<{
2313
+ step_id?: { ... }
2314
+ step_name?: { ... }
2315
+ user_ids?: { ... }
2316
+ }>
2317
+ filter_with_purposes?: boolean
2318
+ }
2319
+ allow_failure?: boolean
2320
+ created_automatically?: boolean
2321
+ is_bulk_action?: boolean
2322
+ reason?: {
2323
+ message?: string
2324
+ payload?: Record<string, unknown>
2325
+ }
2326
+ condition_id?: string
2327
+ schedule_id?: string
2328
+ }
2329
+ ```
2330
+
2331
+ ### `TriggerWorkflowAction`
2332
+
2333
+ ```ts
2334
+ type TriggerWorkflowAction = {
2335
+ type?: "trigger-workflow"
2336
+ config?: {
2337
+ target_workflow?: string
2338
+ conditions?: Array<{
2339
+ source: { ... }
2340
+ comparison: { ... }
2341
+ value?: { ... }
2342
+ schema?: { ... }
2343
+ }>
2344
+ assignees?: string[]
2345
+ assign_steps?: Array<{
2346
+ step_id?: { ... }
2347
+ step_name?: { ... }
2348
+ user_ids?: { ... }
2349
+ }>
2350
+ filter_with_purposes?: boolean
2351
+ }
2352
+ }
2353
+ ```
2354
+
2355
+ ### `TriggerWorkflowConfig`
2356
+
2357
+ ```ts
2358
+ type TriggerWorkflowConfig = {
2359
+ target_workflow?: string
2360
+ conditions?: Array<{
2361
+ source: string
2362
+ comparison: "equals" | "any_of" | "not_empty" | "is_empty"
2363
+ value?: string | number | string[] | number[]
2364
+ schema?: string
2365
+ }>
2366
+ assignees?: string[]
2367
+ assign_steps?: Array<{
2368
+ step_id?: string
2369
+ step_name?: string
2370
+ user_ids?: number[]
2371
+ }>
2372
+ filter_with_purposes?: boolean
2373
+ }
2374
+ ```
2375
+
2376
+ ### `TriggerWorkflowCondition`
2377
+
2378
+ ```ts
2379
+ type TriggerWorkflowCondition = {
2380
+ source: string
2381
+ comparison: "equals" | "any_of" | "not_empty" | "is_empty"
2382
+ value?: string | number | string[] | number[]
2383
+ schema?: string
2384
+ }
2385
+ ```
2386
+
2387
+ ### `TriggerShareEntityActionConfig`
2388
+
2389
+ ```ts
2390
+ type TriggerShareEntityActionConfig = {
2391
+ id?: string
2392
+ flow_action_id?: string
2393
+ name?: string
2394
+ type?: "trigger-workflow"
2395
+ config?: {
2396
+ partner_org_ids?: string[]
2397
+ }
2398
+ allow_failure?: boolean
2399
+ created_automatically?: boolean
2400
+ is_bulk_action?: boolean
2401
+ reason?: {
2402
+ message?: string
2403
+ payload?: Record<string, unknown>
2404
+ }
2405
+ condition_id?: string
2406
+ schedule_id?: string
2407
+ }
2408
+ ```
2409
+
2410
+ ### `TriggerShareEntityAction`
2411
+
2412
+ ```ts
2413
+ type TriggerShareEntityAction = {
2414
+ type?: "trigger-share-entity"
2415
+ config?: {
2416
+ partner_org_ids?: string[]
2417
+ }
2418
+ }
2419
+ ```
2420
+
2421
+ ### `TriggerShareEntityConfig`
2422
+
2423
+ ```ts
2424
+ type TriggerShareEntityConfig = {
2425
+ partner_org_ids?: string[]
2426
+ }
2427
+ ```
2428
+
2429
+ ### `AssignUsersToStep`
2430
+
2431
+ ```ts
2432
+ type AssignUsersToStep = {
2433
+ step_id?: string
2434
+ step_name?: string
2435
+ user_ids?: number[]
2436
+ }
2437
+ ```
2438
+
2439
+ ### `CustomAction`
2440
+
2441
+ ```ts
2442
+ type CustomAction = {
2443
+ type?: "custom-action"
2444
+ config?: {
2445
+ name?: string
2446
+ description?: string
2447
+ app_id?: string
2448
+ component_id?: string
2449
+ wait_for_callback?: boolean
2450
+ }
2451
+ }
2452
+ ```
2453
+
2454
+ ### `TriggerWebhookActionConfig`
2455
+
2456
+ ```ts
2457
+ type TriggerWebhookActionConfig = {
2458
+ id?: string
2459
+ flow_action_id?: string
2460
+ name?: string
2461
+ type?: "trigger-webhook"
2462
+ config?: {
2463
+ event_id?: string
2464
+ entity_sources?: string[]
2465
+ target_webhook_id?: string
2466
+ sync?: boolean
2467
+ }
2468
+ allow_failure?: boolean
2469
+ created_automatically?: boolean
2470
+ is_bulk_action?: boolean
2471
+ reason?: {
2472
+ message?: string
2473
+ payload?: Record<string, unknown>
2474
+ }
2475
+ condition_id?: string
2476
+ schedule_id?: string
2477
+ }
2478
+ ```
2479
+
2480
+ ### `TriggerWebhookAction`
2481
+
2482
+ ```ts
2483
+ type TriggerWebhookAction = {
2484
+ type?: "trigger-webhook"
2485
+ config?: {
2486
+ event_id?: string
2487
+ entity_sources?: string[]
2488
+ target_webhook_id?: string
2489
+ sync?: boolean
2490
+ }
2491
+ }
2492
+ ```
2493
+
2494
+ ### `TriggerWebhookConfig`
2495
+
2496
+ ```ts
2497
+ type TriggerWebhookConfig = {
2498
+ event_id?: string
2499
+ entity_sources?: string[]
2500
+ target_webhook_id?: string
2501
+ sync?: boolean
2502
+ }
2503
+ ```
2504
+
2505
+ ### `InformERPActionConfig`
2506
+
2507
+ ```ts
2508
+ type InformERPActionConfig = {
2509
+ id?: string
2510
+ flow_action_id?: string
2511
+ name?: string
2512
+ type?: "inform-erp"
2513
+ config?: {
2514
+ entity_sources?: string[]
2515
+ target_webhook_id?: string
2516
+ sync?: boolean
2517
+ }
2518
+ allow_failure?: boolean
2519
+ created_automatically?: boolean
2520
+ is_bulk_action?: boolean
2521
+ reason?: {
2522
+ message?: string
2523
+ payload?: Record<string, unknown>
2524
+ }
2525
+ condition_id?: string
2526
+ schedule_id?: string
2527
+ }
2528
+ ```
2529
+
2530
+ ### `InformERPAction`
2531
+
2532
+ ```ts
2533
+ type InformERPAction = {
2534
+ type?: "inform-erp"
2535
+ config?: {
2536
+ entity_sources?: string[]
2537
+ target_webhook_id?: string
2538
+ sync?: boolean
2539
+ }
2540
+ }
2541
+ ```
2542
+
2543
+ ### `InformERPConfig`
2544
+
2545
+ ```ts
2546
+ type InformERPConfig = {
2547
+ entity_sources?: string[]
2548
+ target_webhook_id?: string
2549
+ sync?: boolean
2550
+ }
2551
+ ```
2552
+
2553
+ ### `TriggerEventActionConfig`
2554
+
2555
+ ```ts
2556
+ type TriggerEventActionConfig = {
2557
+ id?: string
2558
+ flow_action_id?: string
2559
+ name?: string
2560
+ type?: "trigger-event"
2561
+ config?: {
2562
+ event_name: string
2563
+ event_inputs?: Record<string, unknown>
2564
+ }
2565
+ allow_failure?: boolean
2566
+ created_automatically?: boolean
2567
+ is_bulk_action?: boolean
2568
+ reason?: {
2569
+ message?: string
2570
+ payload?: Record<string, unknown>
2571
+ }
2572
+ condition_id?: string
2573
+ schedule_id?: string
2574
+ }
2575
+ ```
2576
+
2577
+ ### `TriggerEventAction`
2578
+
2579
+ ```ts
2580
+ type TriggerEventAction = {
2581
+ type?: "trigger-event"
2582
+ config?: {
2583
+ event_name: string
2584
+ event_inputs?: Record<string, unknown>
2585
+ }
2586
+ }
2587
+ ```
2588
+
2589
+ ### `TriggerEventConfig`
2590
+
2591
+ Configuration for triggering an event catalog event
2592
+
2593
+ ```ts
2594
+ type TriggerEventConfig = {
2595
+ event_name: string
2596
+ event_inputs?: Record<string, unknown>
2597
+ }
2598
+ ```
2599
+
2600
+ ### `FlowExecutionCancelActionConfig`
2601
+
2602
+ ```ts
2603
+ type FlowExecutionCancelActionConfig = {
2604
+ id?: string
2605
+ flow_action_id?: string
2606
+ name?: string
2607
+ type?: "cancel-flow-execution"
2608
+ config?: {
2609
+ selected_reasons?: Array<{
2610
+ id: { ... }
2611
+ title: { ... }
2612
+ }>
2613
+ extra_description?: string
2614
+ }
2615
+ allow_failure?: boolean
2616
+ created_automatically?: boolean
2617
+ is_bulk_action?: boolean
2618
+ reason?: {
2619
+ message?: string
2620
+ payload?: Record<string, unknown>
2621
+ }
2622
+ condition_id?: string
2623
+ schedule_id?: string
2624
+ }
2625
+ ```
2626
+
2627
+ ### `FlowExecutionCancelAction`
2628
+
2629
+ ```ts
2630
+ type FlowExecutionCancelAction = {
2631
+ type?: "cancel-flow-execution"
2632
+ config?: {
2633
+ selected_reasons?: Array<{
2634
+ id: { ... }
2635
+ title: { ... }
2636
+ }>
2637
+ extra_description?: string
2638
+ }
2639
+ }
2640
+ ```
2641
+
2642
+ ### `FlowExecutionCancelConfig`
2643
+
2644
+ Configuration for cancelling a flow execution with selected reasons
2645
+
2646
+ ```ts
2647
+ type FlowExecutionCancelConfig = {
2648
+ selected_reasons?: Array<{
2649
+ id: string
2650
+ title: string
2651
+ }>
2652
+ extra_description?: string
2653
+ }
2654
+ ```
2655
+
2656
+ ### `CancellationReason`
2657
+
2658
+ A reason for cancelling a flow execution
2659
+
2660
+ ```ts
2661
+ type CancellationReason = {
2662
+ id: string
2663
+ title: string
2664
+ }
2665
+ ```
2666
+
2667
+ ### `ConditionStatement`
2668
+
2669
+ ```ts
2670
+ type ConditionStatement = {
2671
+ id?: string // uuid
2672
+ source?: {
2673
+ id?: string
2674
+ origin?: "trigger" | "action"
2675
+ originType?: "entity" | "workflow" | "journey_block"
2676
+ schema?: string
2677
+ attribute?: string
2678
+ attributeType?: "string" | "text" | "number" | "boolean" | "date" | "datetime" | "tags" | "country" | "email" | "phone" | "product" | "price" | "status" | "relation" | "multiselect" | "select" | "radio" | "relation_user" | "purpose" | "label" | "payment" | "relation_payment_method"
2679
+ attributeRepeatable?: boolean
2680
+ repeatableItemOp?: boolean
2681
+ attributeOperation?: "all" | "updated" | "added" | "deleted"
2682
+ }
2683
+ 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" | "entity_exists" | "entity_does_not_exist"
2684
+ values?: string[]
2685
+ }
2686
+ ```
2687
+
2688
+ ### `ActionCondition`
2689
+
2690
+ ```ts
2691
+ type ActionCondition = {
2692
+ id?: string
2693
+ schedule_id?: string
2694
+ evaluationResult?: boolean
2695
+ statements?: Array<{
2696
+ id?: string // uuid
2697
+ source?: {
2698
+ id?: { ... }
2699
+ origin?: { ... }
2700
+ originType?: { ... }
2701
+ schema?: { ... }
2702
+ attribute?: { ... }
2703
+ attributeType?: { ... }
2704
+ attributeRepeatable?: { ... }
2705
+ repeatableItemOp?: { ... }
2706
+ attributeOperation?: { ... }
2707
+ }
2708
+ 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" | "entity_exists" | "entity_does_not_exist"
2709
+ values?: string[]
2710
+ }>
2711
+ }
2712
+ ```
2713
+
2714
+ ### `ActionScheduleSource`
2715
+
2716
+ The source of the schedule_at timestamp that will be used to schedule the action
2717
+
2718
+ ```ts
2719
+ type ActionScheduleSource = {
2720
+ id: string
2721
+ origin: "trigger" | "action" | "action_task" | "automation"
2722
+ schema?: string
2723
+ attribute?: string
2724
+ }
2725
+ ```
2726
+
2727
+ ### `ActionSchedule`
2728
+
2729
+ ```ts
2730
+ type ActionSchedule = {
2731
+ id: string
2732
+ scheduleApiId?: string
2733
+ numberOfUnits?: number
2734
+ timePeriod?: "minutes" | "hours" | "days" | "weeks" | "months"
2735
+ timeRelation?: "after" | "before"
2736
+ source: {
2737
+ id: string
2738
+ origin: "trigger" | "action" | "action_task" | "automation"
2739
+ schema?: string
2740
+ attribute?: string
2741
+ }
2742
+ }
2743
+ ```
2744
+
2745
+ ### `AutomationExecutionId`
2746
+
2747
+ ```ts
2748
+ type AutomationExecutionId = string
2749
+ ```
2750
+
2751
+ ### `AutomationExecution`
2752
+
2753
+ ```ts
2754
+ type AutomationExecution = {
2755
+ id: string
2756
+ execution_status?: "pending" | "starting" | "in_progress" | "paused" | "success" | "failed" | "cancelled" | "skipped" | "scheduled" | "hot"
2757
+ entity_id: string
2758
+ activity_id?: string
2759
+ entity_snapshot?: {
2760
+ _id: string
2761
+ _title: string
2762
+ _org: string
2763
+ _schema: string
2764
+ _tags?: string[]
2765
+ _created_at: string // date-time
2766
+ _updated_at: string // date-time
2767
+ }
2768
+ org_id: string
2769
+ flow_id: string
2770
+ flow_name?: string
2771
+ created_at?: string // date-time
2772
+ updated_at?: string // date-time
2773
+ current_action_id?: string
2774
+ conditions?: Array<{
2775
+ id?: string
2776
+ schedule_id?: string
2777
+ evaluationResult?: boolean
2778
+ statements?: Array<{
2779
+ id?: { ... }
2780
+ source?: { ... }
2781
+ operation?: { ... }
2782
+ values?: { ... }
2783
+ }>
2784
+ }>
2785
+ schedules?: Array<{
2786
+ id: string
2787
+ scheduleApiId?: string
2788
+ numberOfUnits?: number
2789
+ timePeriod?: "minutes" | "hours" | "days" | "weeks" | "months"
2790
+ timeRelation?: "after" | "before"
2791
+ source: {
2792
+ id: { ... }
2793
+ origin: { ... }
2794
+ schema?: { ... }
2795
+ attribute?: { ... }
2796
+ }
2797
+ }>
2798
+ actions: Array<{
2799
+ type?: "map-entity"
2800
+ config?: {
2801
+ mapping_config?: { ... }
2802
+ target_schema: { ... }
2803
+ target_unique?: { ... }
2804
+ mapping_attributes?: { ... }
2805
+ relation_attributes?: { ... }
2806
+ linkback_relation_attribute?: { ... }
2807
+ linkback_relation_tags?: { ... }
2808
+ }
2809
+ } | {
2810
+ type?: "trigger-workflow"
2811
+ config?: {
2812
+ target_workflow?: { ... }
2813
+ conditions?: { ... }
2814
+ assignees?: { ... }
2815
+ assign_steps?: { ... }
2816
+ filter_with_purposes?: { ... }
2817
+ }
2818
+ } | {
2819
+ type?: "trigger-share-entity"
2820
+ config?: {
2821
+ partner_org_ids?: { ... }
2822
+ }
2823
+ } | {
2824
+ type?: "trigger-webhook"
2825
+ config?: {
2826
+ event_id?: { ... }
2827
+ entity_sources?: { ... }
2828
+ target_webhook_id?: { ... }
2829
+ sync?: { ... }
2830
+ }
2831
+ } | {
2832
+ type?: "inform-erp"
2833
+ config?: {
2834
+ entity_sources?: { ... }
2835
+ target_webhook_id?: { ... }
2836
+ sync?: { ... }
2837
+ }
2838
+ } | {
2839
+ type?: "trigger-event"
2840
+ config?: {
2841
+ event_name: { ... }
2842
+ event_inputs?: { ... }
2843
+ }
2844
+ } | {
2845
+ type?: "create-document"
2846
+ config?: {
2847
+ template_id?: { ... }
2848
+ filename?: { ... }
2849
+ }
2850
+ } | {
2851
+ type?: "send-email"
2852
+ config?: {
2853
+ email_template_id?: { ... }
2854
+ // ...
2855
+ }
2856
+ ```
2857
+
2858
+ ### `WorkflowExecutionContext`
2859
+
2860
+ ```ts
2861
+ type WorkflowExecutionContext = {
2862
+ workflow_exec_id: string
2863
+ workflow_exec_task_id?: string
2864
+ workflow_role: "trigger_workflow" | "run_task_automation"
2865
+ _execution_chain?: {
2866
+ parent_execution_id?: string
2867
+ parent_task_id?: string
2868
+ depth?: number
2869
+ }
2870
+ }
2871
+ ```
2872
+
2873
+ ### `ExecutionChain`
2874
+
2875
+ [Internal] Tracks execution chain for infinite loop prevention. This is an internal property and should not be used by external consumers.
2876
+
2877
+ ```ts
2878
+ type ExecutionChain = {
2879
+ parent_execution_id?: string
2880
+ parent_task_id?: string
2881
+ depth?: number
2882
+ }
2883
+ ```
2884
+
2885
+ ### `TriggerEventManual`
2886
+
2887
+ ```ts
2888
+ type TriggerEventManual = {
2889
+ type?: "manual"
2890
+ org_id: string
2891
+ entity_id: string
2892
+ caller?: {
2893
+ EpilotAuth?: {
2894
+ claims?: { ... }
2895
+ userId?: { ... }
2896
+ organizationId?: { ... }
2897
+ token?: { ... }
2898
+ }
2899
+ }
2900
+ }
2901
+ ```
2902
+
2903
+ ### `TriggerEventFlowAutomationTask`
2904
+
2905
+ ```ts
2906
+ type TriggerEventFlowAutomationTask = {
2907
+ type?: "flow_automation_task"
2908
+ org_id: string
2909
+ entity_id: string
2910
+ flow_execution_id: string
2911
+ flow_automation_task_id: string // UUID
2912
+ caller?: {
2913
+ EpilotAuth?: {
2914
+ claims?: { ... }
2915
+ userId?: { ... }
2916
+ organizationId?: { ... }
2917
+ token?: { ... }
2918
+ }
2919
+ }
2920
+ }
2921
+ ```
2922
+
2923
+ ### `TriggerEventEntityActivity`
2924
+
2925
+ ```ts
2926
+ type TriggerEventEntityActivity = {
2927
+ type?: "entity_activity"
2928
+ org_id: string
2929
+ activity_id: string
2930
+ activity_type: string
2931
+ entity_id?: string
2932
+ }
2933
+ ```
2934
+
2935
+ ### `TriggerEventMessaging`
2936
+
2937
+ ```ts
2938
+ type TriggerEventMessaging = {
2939
+ type?: "new_email_thread"
2940
+ org_id: string
2941
+ thread_id: string
2942
+ message_id: string
2943
+ entity_id: string
2944
+ }
2945
+ ```
2946
+
2947
+ ### `TriggerEventEntityOperation`
2948
+
2949
+ ```ts
2950
+ type TriggerEventEntityOperation = {
2951
+ type?: "entity_operation"
2952
+ entity_id: string
2953
+ org_id: string
2954
+ activity_id: string
2955
+ operation_type: "createEntity" | "updateEntity" | "deleteEntity" | "softDeleteEntity" | "restoreEntity"
2956
+ }
2957
+ ```
2958
+
2959
+ ### `ApiCallerContext`
2960
+
2961
+ ```ts
2962
+ type ApiCallerContext = {
2963
+ EpilotAuth?: {
2964
+ claims?: {
2965
+ userId?: { ... }
2966
+ sub?: { ... }
2967
+ email?: { ... }
2968
+ cognito:username?: { ... }
2969
+ custom:ivy_user_id?: { ... }
2970
+ }
2971
+ userId?: string
2972
+ organizationId?: string
2973
+ token?: string
2974
+ }
2975
+ }
2976
+ ```
2977
+
2978
+ ### `ExecutionStatus`
2979
+
2980
+ ```ts
2981
+ type ExecutionStatus = "pending" | "starting" | "in_progress" | "paused" | "success" | "failed" | "cancelled" | "skipped" | "scheduled" | "hot"
2982
+ ```
2983
+
2984
+ ### `GetExecutionsResp`
2985
+
2986
+ ```ts
2987
+ type GetExecutionsResp = {
2988
+ total: number
2989
+ results: Array<{
2990
+ id: string
2991
+ execution_status?: "pending" | "starting" | "in_progress" | "paused" | "success" | "failed" | "cancelled" | "skipped" | "scheduled" | "hot"
2992
+ entity_id: string
2993
+ activity_id?: string
2994
+ entity_snapshot?: {
2995
+ _id: { ... }
2996
+ _title: { ... }
2997
+ _org: { ... }
2998
+ _schema: { ... }
2999
+ _tags?: { ... }
3000
+ _created_at: { ... }
3001
+ _updated_at: { ... }
3002
+ }
3003
+ org_id: string
3004
+ flow_id: string
3005
+ flow_name?: string
3006
+ created_at?: string // date-time
3007
+ updated_at?: string // date-time
3008
+ current_action_id?: string
3009
+ conditions?: Array<{
3010
+ id?: { ... }
3011
+ schedule_id?: { ... }
3012
+ evaluationResult?: { ... }
3013
+ statements?: { ... }
3014
+ }>
3015
+ schedules?: Array<{
3016
+ id: { ... }
3017
+ scheduleApiId?: { ... }
3018
+ numberOfUnits?: { ... }
3019
+ timePeriod?: { ... }
3020
+ timeRelation?: { ... }
3021
+ source: { ... }
3022
+ }>
3023
+ actions: Array<{
3024
+ type?: { ... }
3025
+ config?: { ... }
3026
+ } | {
3027
+ type?: { ... }
3028
+ config?: { ... }
3029
+ } | {
3030
+ type?: { ... }
3031
+ config?: { ... }
3032
+ } | {
3033
+ type?: { ... }
3034
+ config?: { ... }
3035
+ } | {
3036
+ type?: { ... }
3037
+ config?: { ... }
3038
+ } | {
3039
+ type?: { ... }
3040
+ config?: { ... }
3041
+ } | {
3042
+ type?: { ... }
3043
+ config?: { ... }
3044
+ } | {
3045
+ type?: { ... }
3046
+ config?: { ... }
3047
+ } | {
3048
+ type?: { ... }
3049
+ config?: { ... }
3050
+ } | {
3051
+ type?: { ... }
3052
+ config?: { ... }
3053
+ } | {
3054
+ id?: { ... }
3055
+ flow_action_id?: { ... }
3056
+ name?: { ... }
3057
+ type?: { ... }
3058
+ config?: { ... }
3059
+ allow_failure?: { ... }
3060
+ created_automatically?: { ... }
3061
+ is_bulk_action?: { ... }
3062
+ reason?: { ... }
3063
+ condition_id?: { ... }
3064
+ schedule_id?: { ... }
3065
+ execution_status?: { ... }
3066
+ started_at?: { ... }
3067
+ updated_at?: { ... }
3068
+ outputs?: { ... }
3069
+ error_output?: { ... }
3070
+ retry_strategy?: { ... }
3071
+ } | {
3072
+ type?: { ... }
3073
+ config?: { ... }
3074
+ }>
3075
+ resume_token?: string
3076
+ trigger_context?: Record<string, string>
3077
+ version?: number
3078
+ trigger_event?: {
3079
+ type?: { ... }
3080
+ org_id: { ... }
3081
+ entity_id: { ... }
3082
+ caller?: { ... }
3083
+ } | {
3084
+ type?: { ... }
3085
+ org_id: { ... }
3086
+ activity_id: { ... }
3087
+ // ...
3088
+ }
3089
+ ```
3090
+
3091
+ ### `StartExecutionRequest`
3092
+
3093
+ ```ts
3094
+ type StartExecutionRequest = {
3095
+ entity_id: string
3096
+ flow_id: string
3097
+ workflow_context?: {
3098
+ workflow_exec_id: string
3099
+ workflow_exec_task_id?: string
3100
+ workflow_role: "trigger_workflow" | "run_task_automation"
3101
+ _execution_chain?: {
3102
+ parent_execution_id?: { ... }
3103
+ parent_task_id?: { ... }
3104
+ depth?: { ... }
3105
+ }
3106
+ }
3107
+ flow_execution_id?: string
3108
+ flow_automation_task_id?: string
3109
+ }
3110
+ ```
3111
+
3112
+ ### `PatchBulkJobRequest`
3113
+
3114
+ ```ts
3115
+ type PatchBulkJobRequest = {
3116
+ action: "APPROVE" | "CANCEL"
3117
+ task_token: string
3118
+ }
3119
+ ```
3120
+
3121
+ ### `BulkTriggerRequest`
3122
+
3123
+ ```ts
3124
+ type BulkTriggerRequest = {
3125
+ flow_id: string
3126
+ entities_refs: Array<{
3127
+ entity_id: string
3128
+ entity_schema: string
3129
+ }>
3130
+ trigger_context?: Record<string, string>
3131
+ } | {
3132
+ flow_id: string
3133
+ entities_query: string
3134
+ trigger_context?: Record<string, string>
3135
+ } | {
3136
+ flow_id: string
3137
+ entities_filter: Array<{
3138
+ term?: Record<string, string | number | boolean>
3139
+ terms?: Record<string, string | number | boolean[]>
3140
+ ids?: {
3141
+ values?: { ... }
3142
+ }
3143
+ range?: Record<string, {
3144
+ gt?: { ... }
3145
+ gte?: { ... }
3146
+ lt?: { ... }
3147
+ lte?: { ... }
3148
+ format?: { ... }
3149
+ relation?: { ... }
3150
+ time_zone?: { ... }
3151
+ }>
3152
+ exists?: {
3153
+ field: { ... }
3154
+ }
3155
+ $and?: Array<{
3156
+ term?: { ... }
3157
+ terms?: { ... }
3158
+ ids?: { ... }
3159
+ range?: { ... }
3160
+ exists?: { ... }
3161
+ $and?: { ... }
3162
+ $or?: { ... }
3163
+ $not?: { ... }
3164
+ }>
3165
+ $or?: Array<{
3166
+ term?: { ... }
3167
+ terms?: { ... }
3168
+ ids?: { ... }
3169
+ range?: { ... }
3170
+ exists?: { ... }
3171
+ $and?: { ... }
3172
+ $or?: { ... }
3173
+ $not?: { ... }
3174
+ }>
3175
+ $not?: Array<{
3176
+ term?: { ... }
3177
+ terms?: { ... }
3178
+ ids?: { ... }
3179
+ range?: { ... }
3180
+ exists?: { ... }
3181
+ $and?: { ... }
3182
+ $or?: { ... }
3183
+ $not?: { ... }
3184
+ }>
3185
+ }>
3186
+ trigger_context?: Record<string, string>
3187
+ }
3188
+ ```
3189
+
3190
+ ### `EntityRef`
3191
+
3192
+ ```ts
3193
+ type EntityRef = {
3194
+ entity_id: string
3195
+ entity_schema: string
3196
+ }
3197
+ ```
3198
+
3199
+ ### `BulkTriggerJob`
3200
+
3201
+ ```ts
3202
+ type BulkTriggerJob = {
3203
+ job_id: string
3204
+ org_id: string
3205
+ flow_id: string
3206
+ status: "approval" | "querying_entities" | "entities_loaded" | "executing" | "monitoring" | "send_report" | "finished" | "failed" | "cancelled"
3207
+ created_by: string
3208
+ created_at: string // date-time
3209
+ updated_at: string // date-time
3210
+ approved_at?: string // date-time
3211
+ trigger_context?: Record<string, string>
3212
+ task_token?: string
3213
+ report_file_entity_id?: string
3214
+ entity_query?: {
3215
+ type: "refs" | "query" | "filter"
3216
+ data: Array<{
3217
+ entity_id: { ... }
3218
+ entity_schema: { ... }
3219
+ }> | string | Array<{
3220
+ term?: { ... }
3221
+ terms?: { ... }
3222
+ ids?: { ... }
3223
+ range?: { ... }
3224
+ exists?: { ... }
3225
+ $and?: { ... }
3226
+ $or?: { ... }
3227
+ $not?: { ... }
3228
+ }>
3229
+ }
3230
+ pagination_state?: {
3231
+ page_size?: number
3232
+ pages_processed?: number
3233
+ total_processed?: number
3234
+ stable_query_id?: string
3235
+ search_after?: string | number[]
3236
+ has_more?: boolean
3237
+ }
3238
+ execution_summary?: Array<{
3239
+ entity_id: string
3240
+ entity_schema?: string
3241
+ execution_id?: string
3242
+ execution_status: "pending" | "starting" | "in_progress" | "paused" | "success" | "failed" | "cancelled" | "skipped" | "scheduled" | "hot"
3243
+ timestamp?: string // date-time
3244
+ error?: string
3245
+ }>
3246
+ }
3247
+ ```
3248
+
3249
+ ### `ExecItem`
3250
+
3251
+ Execution item for bulk trigger automation. It maps each entity to its automation execution id & status
3252
+
3253
+ ```ts
3254
+ type ExecItem = {
3255
+ entity_id: string
3256
+ entity_schema?: string
3257
+ execution_id?: string
3258
+ execution_status: "pending" | "starting" | "in_progress" | "paused" | "success" | "failed" | "cancelled" | "skipped" | "scheduled" | "hot"
3259
+ timestamp?: string // date-time
3260
+ error?: string
3261
+ }
3262
+ ```
3263
+
3264
+ ### `JobId`
3265
+
3266
+ Job ID for tracking the status of bulk trigger automation executions
3267
+
3268
+ ```ts
3269
+ type JobId = string
3270
+ ```
3271
+
3272
+ ### `EntityId`
3273
+
3274
+ ```ts
3275
+ type EntityId = string
3276
+ ```
3277
+
3278
+ ### `ActivityId`
3279
+
3280
+ ```ts
3281
+ type ActivityId = string
3282
+ ```
3283
+
3284
+ ### `OrganizationId`
3285
+
3286
+ ```ts
3287
+ type OrganizationId = string
3288
+ ```
3289
+
3290
+ ### `TriggerContext`
3291
+
3292
+ Additional contextual data for a bulk trigger automation. This would normally include additional entity IDs you'd need after a listener picks up an event.
3293
+
3294
+ ```ts
3295
+ type TriggerContext = Record<string, string>
3296
+ ```
3297
+
3298
+ ### `AutomationTrigger`
3299
+
3300
+ ```ts
3301
+ type AutomationTrigger = {
3302
+ id?: string // uuid
3303
+ }
3304
+ ```
3305
+
3306
+ ### `FlowsTrigger`
3307
+
3308
+ ```ts
3309
+ type FlowsTrigger = {
3310
+ id?: string // uuid
3311
+ type: "flows_trigger"
3312
+ configuration?: {
3313
+ journey_id?: string // uuid
3314
+ }
3315
+ }
3316
+ ```
3317
+
3318
+ ### `JourneySubmitTrigger`
3319
+
3320
+ ```ts
3321
+ type JourneySubmitTrigger = {
3322
+ id?: string // uuid
3323
+ type: "journey_submission"
3324
+ configuration: {
3325
+ source_id: string // uuid
3326
+ }
3327
+ }
3328
+ ```
3329
+
3330
+ ### `FrontendSubmitTrigger`
3331
+
3332
+ ```ts
3333
+ type FrontendSubmitTrigger = {
3334
+ id?: string // uuid
3335
+ type: "frontend_submission"
3336
+ configuration: {
3337
+ source_id?: string
3338
+ }
3339
+ }
3340
+ ```
3341
+
3342
+ ### `ApiSubmissionTrigger`
3343
+
3344
+ ```ts
3345
+ type ApiSubmissionTrigger = {
3346
+ id?: string // uuid
3347
+ type: "api_submission"
3348
+ configuration: {
3349
+ source_id?: string
3350
+ }
3351
+ }
3352
+ ```
3353
+
3354
+ ### `NewEmailThreadTrigger`
3355
+
3356
+ ```ts
3357
+ type NewEmailThreadTrigger = {
3358
+ id?: string // uuid
3359
+ type: "new_email_thread"
3360
+ configuration: {
3361
+ shared_inbox_ids?: string[]
3362
+ direction: "INBOUND" | "OUTBOUND" | "BOTH"
3363
+ }
3364
+ }
3365
+ ```
3366
+
3367
+ ### `ReceivedEmailTrigger`
3368
+
3369
+ ```ts
3370
+ type ReceivedEmailTrigger = {
3371
+ id?: string // uuid
3372
+ type: "received_email"
3373
+ configuration: {
3374
+ message_type?: "RECEIVED"
3375
+ }
3376
+ }
3377
+ ```
3378
+
3379
+ ### `EntityOperationTrigger`
3380
+
3381
+ - If provides filter_config, executes an automation based on the filtered configuration when an entity event occurs.
3382
+ - The conditions on a filter follows the event bridge patterns - `https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html`
3383
+ | Comparison | Example
3384
+
3385
+ ```ts
3386
+ type EntityOperationTrigger = {
3387
+ id?: string // uuid
3388
+ type: "entity_operation"
3389
+ configuration: {
3390
+ schema?: string
3391
+ operations?: "createEntity" | "updateEntity" | "deleteEntity" | "softDeleteEntity" | "restoreEntity"[]
3392
+ include_activities?: string[]
3393
+ exclude_activities?: string[]
3394
+ filter_config?: {
3395
+ operation?: { ... }
3396
+ activity?: { ... }
3397
+ }
3398
+ ecp_config?: {
3399
+ origin?: { ... }
3400
+ portal_id?: { ... }
3401
+ file_config?: { ... }
3402
+ }
3403
+ }
3404
+ }
3405
+ ```
3406
+
3407
+ ### `ActivityTrigger`
3408
+
3409
+ ```ts
3410
+ type ActivityTrigger = {
3411
+ id?: string // uuid
3412
+ type: "activity"
3413
+ configuration: {
3414
+ schema?: string
3415
+ types?: "CreateMeterReading" | "UpdateMeterReading" | "DocDownloadedFromPortal" | "PortalUserResetPassword" | "PortalUserResetForgotPassword" | "SelfAssignmentFromPortal" | string[]
3416
+ }
3417
+ }
3418
+ ```
3419
+
3420
+ ### `EntityOperation`
3421
+
3422
+ ```ts
3423
+ type EntityOperation = "createEntity" | "updateEntity" | "deleteEntity" | "softDeleteEntity" | "restoreEntity"
3424
+ ```
3425
+
3426
+ ### `EntitySearchFilter`
3427
+
3428
+ A subset of simplified Elasticsearch query clauses. The default operator is a logical AND. Use nested $and, $or, $not to combine filters using different logical operators.
3429
+
3430
+ ```ts
3431
+ type EntitySearchFilter = Array<{
3432
+ term?: Record<string, string | number | boolean>
3433
+ terms?: Record<string, string | number | boolean[]>
3434
+ ids?: {
3435
+ values?: string[]
3436
+ }
3437
+ range?: Record<string, {
3438
+ gt?: string | number | boolean
3439
+ gte?: string | number | boolean
3440
+ lt?: string | number | boolean
3441
+ lte?: string | number | boolean
3442
+ format?: string
3443
+ relation?: "INTERSECTS" | "CONTAINS" | "WITHIN"
3444
+ time_zone?: string
3445
+ }>
3446
+ exists?: {
3447
+ field: string
3448
+ }
3449
+ $and?: Array<{
3450
+ term?: Record<string, string | number | boolean>
3451
+ terms?: Record<string, string | number | boolean[]>
3452
+ ids?: {
3453
+ values?: { ... }
3454
+ }
3455
+ range?: Record<string, {
3456
+ gt?: { ... }
3457
+ gte?: { ... }
3458
+ lt?: { ... }
3459
+ lte?: { ... }
3460
+ format?: { ... }
3461
+ relation?: { ... }
3462
+ time_zone?: { ... }
3463
+ }>
3464
+ exists?: {
3465
+ field: { ... }
3466
+ }
3467
+ $and?: Array<{
3468
+ term?: { ... }
3469
+ terms?: { ... }
3470
+ ids?: { ... }
3471
+ range?: { ... }
3472
+ exists?: { ... }
3473
+ $and?: { ... }
3474
+ $or?: { ... }
3475
+ $not?: { ... }
3476
+ }>
3477
+ $or?: Array<{
3478
+ term?: { ... }
3479
+ terms?: { ... }
3480
+ ids?: { ... }
3481
+ range?: { ... }
3482
+ exists?: { ... }
3483
+ $and?: { ... }
3484
+ $or?: { ... }
3485
+ $not?: { ... }
3486
+ }>
3487
+ $not?: Array<{
3488
+ term?: { ... }
3489
+ terms?: { ... }
3490
+ ids?: { ... }
3491
+ range?: { ... }
3492
+ exists?: { ... }
3493
+ $and?: { ... }
3494
+ $or?: { ... }
3495
+ $not?: { ... }
3496
+ }>
3497
+ }>
3498
+ $or?: Array<{
3499
+ term?: Record<string, string | number | boolean>
3500
+ terms?: Record<string, string | number | boolean[]>
3501
+ ids?: {
3502
+ values?: { ... }
3503
+ }
3504
+ range?: Record<string, {
3505
+ gt?: { ... }
3506
+ gte?: { ... }
3507
+ lt?: { ... }
3508
+ lte?: { ... }
3509
+ format?: { ... }
3510
+ relation?: { ... }
3511
+ time_zone?: { ... }
3512
+ }>
3513
+ exists?: {
3514
+ field: { ... }
3515
+ }
3516
+ $and?: Array<{
3517
+ term?: { ... }
3518
+ terms?: { ... }
3519
+ ids?: { ... }
3520
+ range?: { ... }
3521
+ exists?: { ... }
3522
+ $and?: { ... }
3523
+ $or?: { ... }
3524
+ $not?: { ... }
3525
+ }>
3526
+ $or?: Array<{
3527
+ term?: { ... }
3528
+ terms?: { ... }
3529
+ ids?: { ... }
3530
+ range?: { ... }
3531
+ // ...
3532
+ }
3533
+ ```
3534
+
3535
+ ### `EntitySearchFilterValue`
3536
+
3537
+ A filter field value.
3538
+
3539
+ ```ts
3540
+ type EntitySearchFilterValue = string | number | boolean
3541
+ ```
3542
+
3543
+ ### `EntityManualTrigger`
3544
+
3545
+ ```ts
3546
+ type EntityManualTrigger = {
3547
+ id?: string // uuid
3548
+ type: "entity_manual"
3549
+ configuration: {
3550
+ schema?: string
3551
+ }
3552
+ }
3553
+ ```
3554
+
3555
+ ### `TriggerCondition`
3556
+
3557
+ ```ts
3558
+ type TriggerCondition = {
3559
+ source: string
3560
+ comparison: "equals" | "any_of" | "not_empty" | "is_empty"
3561
+ value?: string | number | string[] | number[]
3562
+ }
3563
+ ```
3564
+
3565
+ ### `Comparison`
3566
+
3567
+ ```ts
3568
+ type Comparison = "equals" | "any_of" | "not_empty" | "is_empty"
3569
+ ```
3570
+
3571
+ ### `FilterConditionOnEvent`
3572
+
3573
+ ```ts
3574
+ type FilterConditionOnEvent = {
3575
+ $or?: Array<{
3576
+ $or?: Array<{
3577
+ $or?: { ... }
3578
+ } | Record<string, Array<string | {
3579
+ equals-ignore-case?: { ... }
3580
+ } | {
3581
+ anything-but?: { ... }
3582
+ } | {
3583
+ numeric?: { ... }
3584
+ } | {
3585
+ exists?: { ... }
3586
+ } | {
3587
+ prefix?: { ... }
3588
+ } | {
3589
+ suffix?: { ... }
3590
+ } | {
3591
+ wildcard?: { ... }
3592
+ }>>>
3593
+ } | Record<string, Array<string | {
3594
+ equals-ignore-case?: string
3595
+ } | {
3596
+ anything-but?: string[]
3597
+ } | {
3598
+ numeric?: string | number[]
3599
+ } | {
3600
+ exists?: boolean
3601
+ } | {
3602
+ prefix?: string
3603
+ } | {
3604
+ suffix?: string
3605
+ } | {
3606
+ wildcard?: string
3607
+ }>>>
3608
+ } | Record<string, Array<string | {
3609
+ equals-ignore-case?: string
3610
+ } | {
3611
+ anything-but?: string[]
3612
+ } | {
3613
+ numeric?: string | number[]
3614
+ } | {
3615
+ exists?: boolean
3616
+ } | {
3617
+ prefix?: string
3618
+ } | {
3619
+ suffix?: string
3620
+ } | {
3621
+ wildcard?: string
3622
+ }>>
3623
+ ```
3624
+
3625
+ ### `EqualsIgnoreCaseCondition`
3626
+
3627
+ ```ts
3628
+ type EqualsIgnoreCaseCondition = {
3629
+ equals-ignore-case?: string
3630
+ }
3631
+ ```
3632
+
3633
+ ### `AnythingButCondition`
3634
+
3635
+ ```ts
3636
+ type AnythingButCondition = {
3637
+ anything-but?: string[]
3638
+ }
3639
+ ```
3640
+
3641
+ ### `NumericCondition`
3642
+
3643
+ ```ts
3644
+ type NumericCondition = {
3645
+ numeric?: string | number[]
3646
+ }
3647
+ ```
3648
+
3649
+ ### `ExistsCondition`
3650
+
3651
+ ```ts
3652
+ type ExistsCondition = {
3653
+ exists?: boolean
3654
+ }
3655
+ ```
3656
+
3657
+ ### `PrefixCondition`
3658
+
3659
+ ```ts
3660
+ type PrefixCondition = {
3661
+ prefix?: string
3662
+ }
3663
+ ```
3664
+
3665
+ ### `SuffixCondition`
3666
+
3667
+ ```ts
3668
+ type SuffixCondition = {
3669
+ suffix?: string
3670
+ }
3671
+ ```
3672
+
3673
+ ### `WildcardCondition`
3674
+
3675
+ ```ts
3676
+ type WildcardCondition = {
3677
+ wildcard?: string
3678
+ }
3679
+ ```
3680
+
3681
+ ### `OrCondition`
3682
+
3683
+ ```ts
3684
+ type OrCondition = {
3685
+ $or?: Array<{
3686
+ $or?: Array<{
3687
+ $or?: { ... }
3688
+ } | Record<string, Array<string | {
3689
+ equals-ignore-case?: { ... }
3690
+ } | {
3691
+ anything-but?: { ... }
3692
+ } | {
3693
+ numeric?: { ... }
3694
+ } | {
3695
+ exists?: { ... }
3696
+ } | {
3697
+ prefix?: { ... }
3698
+ } | {
3699
+ suffix?: { ... }
3700
+ } | {
3701
+ wildcard?: { ... }
3702
+ }>>>
3703
+ } | Record<string, Array<string | {
3704
+ equals-ignore-case?: string
3705
+ } | {
3706
+ anything-but?: string[]
3707
+ } | {
3708
+ numeric?: string | number[]
3709
+ } | {
3710
+ exists?: boolean
3711
+ } | {
3712
+ prefix?: string
3713
+ } | {
3714
+ suffix?: string
3715
+ } | {
3716
+ wildcard?: string
3717
+ }>>>
3718
+ }
3719
+ ```
3720
+
3721
+ ### `DiffAdded`
3722
+
3723
+ ```ts
3724
+ type DiffAdded = {
3725
+ $or?: Array<{
3726
+ $or?: Array<{
3727
+ $or?: { ... }
3728
+ } | Record<string, Array<string | {
3729
+ equals-ignore-case?: { ... }
3730
+ } | {
3731
+ anything-but?: { ... }
3732
+ } | {
3733
+ numeric?: { ... }
3734
+ } | {
3735
+ exists?: { ... }
3736
+ } | {
3737
+ prefix?: { ... }
3738
+ } | {
3739
+ suffix?: { ... }
3740
+ } | {
3741
+ wildcard?: { ... }
3742
+ }>>>
3743
+ } | Record<string, Array<string | {
3744
+ equals-ignore-case?: string
3745
+ } | {
3746
+ anything-but?: string[]
3747
+ } | {
3748
+ numeric?: string | number[]
3749
+ } | {
3750
+ exists?: boolean
3751
+ } | {
3752
+ prefix?: string
3753
+ } | {
3754
+ suffix?: string
3755
+ } | {
3756
+ wildcard?: string
3757
+ }>>>
3758
+ } | Record<string, Array<string | {
3759
+ equals-ignore-case?: string
3760
+ } | {
3761
+ anything-but?: string[]
3762
+ } | {
3763
+ numeric?: string | number[]
3764
+ } | {
3765
+ exists?: boolean
3766
+ } | {
3767
+ prefix?: string
3768
+ } | {
3769
+ suffix?: string
3770
+ } | {
3771
+ wildcard?: string
3772
+ }>>
3773
+ ```
3774
+
3775
+ ### `DiffUpdated`
3776
+
3777
+ ```ts
3778
+ type DiffUpdated = {
3779
+ $or?: Array<{
3780
+ $or?: Array<{
3781
+ $or?: { ... }
3782
+ } | Record<string, Array<string | {
3783
+ equals-ignore-case?: { ... }
3784
+ } | {
3785
+ anything-but?: { ... }
3786
+ } | {
3787
+ numeric?: { ... }
3788
+ } | {
3789
+ exists?: { ... }
3790
+ } | {
3791
+ prefix?: { ... }
3792
+ } | {
3793
+ suffix?: { ... }
3794
+ } | {
3795
+ wildcard?: { ... }
3796
+ }>>>
3797
+ } | Record<string, Array<string | {
3798
+ equals-ignore-case?: string
3799
+ } | {
3800
+ anything-but?: string[]
3801
+ } | {
3802
+ numeric?: string | number[]
3803
+ } | {
3804
+ exists?: boolean
3805
+ } | {
3806
+ prefix?: string
3807
+ } | {
3808
+ suffix?: string
3809
+ } | {
3810
+ wildcard?: string
3811
+ }>>>
3812
+ } | Record<string, Array<string | {
3813
+ equals-ignore-case?: string
3814
+ } | {
3815
+ anything-but?: string[]
3816
+ } | {
3817
+ numeric?: string | number[]
3818
+ } | {
3819
+ exists?: boolean
3820
+ } | {
3821
+ prefix?: string
3822
+ } | {
3823
+ suffix?: string
3824
+ } | {
3825
+ wildcard?: string
3826
+ }>>
3827
+ ```
3828
+
3829
+ ### `DiffDeleted`
3830
+
3831
+ ```ts
3832
+ type DiffDeleted = {
3833
+ $or?: Array<{
3834
+ $or?: Array<{
3835
+ $or?: { ... }
3836
+ } | Record<string, Array<string | {
3837
+ equals-ignore-case?: { ... }
3838
+ } | {
3839
+ anything-but?: { ... }
3840
+ } | {
3841
+ numeric?: { ... }
3842
+ } | {
3843
+ exists?: { ... }
3844
+ } | {
3845
+ prefix?: { ... }
3846
+ } | {
3847
+ suffix?: { ... }
3848
+ } | {
3849
+ wildcard?: { ... }
3850
+ }>>>
3851
+ } | Record<string, Array<string | {
3852
+ equals-ignore-case?: string
3853
+ } | {
3854
+ anything-but?: string[]
3855
+ } | {
3856
+ numeric?: string | number[]
3857
+ } | {
3858
+ exists?: boolean
3859
+ } | {
3860
+ prefix?: string
3861
+ } | {
3862
+ suffix?: string
3863
+ } | {
3864
+ wildcard?: string
3865
+ }>>>
3866
+ } | Record<string, Array<string | {
3867
+ equals-ignore-case?: string
3868
+ } | {
3869
+ anything-but?: string[]
3870
+ } | {
3871
+ numeric?: string | number[]
3872
+ } | {
3873
+ exists?: boolean
3874
+ } | {
3875
+ prefix?: string
3876
+ } | {
3877
+ suffix?: string
3878
+ } | {
3879
+ wildcard?: string
3880
+ }>>
3881
+ ```
3882
+
3883
+ ### `OrConditionForDiff`
3884
+
3885
+ ```ts
3886
+ type OrConditionForDiff = {
3887
+ $or?: unknown | unknown | unknown[]
3888
+ }
3889
+ ```
3890
+
3891
+ ### `EntityItemSnapshot`
3892
+
3893
+ ```ts
3894
+ type EntityItemSnapshot = {
3895
+ _id: string
3896
+ _title: string
3897
+ _org: string
3898
+ _schema: string
3899
+ _tags?: string[]
3900
+ _created_at: string // date-time
3901
+ _updated_at: string // date-time
3902
+ }
3903
+ ```
3904
+
3905
+ ### `RetryReq`
3906
+
3907
+ ```ts
3908
+ type RetryReq = {
3909
+ condition_id?: string
3910
+ retry_strategy?: "RETRY_AND_RESUME" | "RETRY_AND_STOP" | "RETRY_ALL_PARENT_CONDITION_ACTIONS"
3911
+ }
3912
+ ```
3913
+
3914
+ ### `ResumeToken`
3915
+
3916
+ A unique token to resume a paused automation execution
3917
+
3918
+ ```ts
3919
+ type ResumeToken = string
3920
+ ```
3921
+
3922
+ ### `ResumeReq`
3923
+
3924
+ ```ts
3925
+ type ResumeReq = {
3926
+ resume_token: string
3927
+ }
3928
+ ```
3929
+
3930
+ ### `ResumeResp`
3931
+
3932
+ ```ts
3933
+ type ResumeResp = {
3934
+ execution: {
3935
+ id: string
3936
+ execution_status?: "pending" | "starting" | "in_progress" | "paused" | "success" | "failed" | "cancelled" | "skipped" | "scheduled" | "hot"
3937
+ entity_id: string
3938
+ activity_id?: string
3939
+ entity_snapshot?: {
3940
+ _id: { ... }
3941
+ _title: { ... }
3942
+ _org: { ... }
3943
+ _schema: { ... }
3944
+ _tags?: { ... }
3945
+ _created_at: { ... }
3946
+ _updated_at: { ... }
3947
+ }
3948
+ org_id: string
3949
+ flow_id: string
3950
+ flow_name?: string
3951
+ created_at?: string // date-time
3952
+ updated_at?: string // date-time
3953
+ current_action_id?: string
3954
+ conditions?: Array<{
3955
+ id?: { ... }
3956
+ schedule_id?: { ... }
3957
+ evaluationResult?: { ... }
3958
+ statements?: { ... }
3959
+ }>
3960
+ schedules?: Array<{
3961
+ id: { ... }
3962
+ scheduleApiId?: { ... }
3963
+ numberOfUnits?: { ... }
3964
+ timePeriod?: { ... }
3965
+ timeRelation?: { ... }
3966
+ source: { ... }
3967
+ }>
3968
+ actions: Array<{
3969
+ type?: { ... }
3970
+ config?: { ... }
3971
+ } | {
3972
+ type?: { ... }
3973
+ config?: { ... }
3974
+ } | {
3975
+ type?: { ... }
3976
+ config?: { ... }
3977
+ } | {
3978
+ type?: { ... }
3979
+ config?: { ... }
3980
+ } | {
3981
+ type?: { ... }
3982
+ config?: { ... }
3983
+ } | {
3984
+ type?: { ... }
3985
+ config?: { ... }
3986
+ } | {
3987
+ type?: { ... }
3988
+ config?: { ... }
3989
+ } | {
3990
+ type?: { ... }
3991
+ config?: { ... }
3992
+ } | {
3993
+ type?: { ... }
3994
+ config?: { ... }
3995
+ } | {
3996
+ type?: { ... }
3997
+ config?: { ... }
3998
+ } | {
3999
+ id?: { ... }
4000
+ flow_action_id?: { ... }
4001
+ name?: { ... }
4002
+ type?: { ... }
4003
+ config?: { ... }
4004
+ allow_failure?: { ... }
4005
+ created_automatically?: { ... }
4006
+ is_bulk_action?: { ... }
4007
+ reason?: { ... }
4008
+ condition_id?: { ... }
4009
+ schedule_id?: { ... }
4010
+ execution_status?: { ... }
4011
+ started_at?: { ... }
4012
+ updated_at?: { ... }
4013
+ outputs?: { ... }
4014
+ error_output?: { ... }
4015
+ retry_strategy?: { ... }
4016
+ } | {
4017
+ type?: { ... }
4018
+ config?: { ... }
4019
+ }>
4020
+ resume_token?: string
4021
+ trigger_context?: Record<string, string>
4022
+ version?: number
4023
+ trigger_event?: {
4024
+ type?: { ... }
4025
+ org_id: { ... }
4026
+ entity_id: { ... }
4027
+ caller?: { ... }
4028
+ } | {
4029
+ type?: { ... }
4030
+ org_id: { ... }
4031
+ activity_id: { ... }
4032
+ activity_type: { ... }
4033
+ // ...
4034
+ }
4035
+ ```
4036
+
4037
+ ### `ErrorObject`
4038
+
4039
+ ```ts
4040
+ type ErrorObject = {
4041
+ status?: number
4042
+ error?: string
4043
+ }
4044
+ ```