@epilot/sdk 2.0.0-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (381) hide show
  1. package/README.md +294 -0
  2. package/dist/access-token-MYDOBCIY.cjs +89 -0
  3. package/dist/access-token-Y5JR7PRG.js +89 -0
  4. package/dist/access-token.d-C2qnueDV.d.cts +553 -0
  5. package/dist/access-token.d-C2qnueDV.d.ts +553 -0
  6. package/dist/address-3RQRG3MK.js +84 -0
  7. package/dist/address-LQUTDOUA.cjs +84 -0
  8. package/dist/address-suggestions-PEKSA7B2.cjs +132 -0
  9. package/dist/address-suggestions-QNK5JWNH.js +132 -0
  10. package/dist/address-suggestions.d-CewXYNYH.d.cts +340 -0
  11. package/dist/address-suggestions.d-CewXYNYH.d.ts +340 -0
  12. package/dist/address.d-DP_aE2ex.d.cts +438 -0
  13. package/dist/address.d-DP_aE2ex.d.ts +438 -0
  14. package/dist/ai-agents-MO4PK2RJ.cjs +215 -0
  15. package/dist/ai-agents-OHP2F243.js +215 -0
  16. package/dist/ai-agents.d-vG-1utqk.d.cts +1340 -0
  17. package/dist/ai-agents.d-vG-1utqk.d.ts +1340 -0
  18. package/dist/apis/access-token.cjs +33 -0
  19. package/dist/apis/access-token.d.cts +18 -0
  20. package/dist/apis/access-token.d.ts +18 -0
  21. package/dist/apis/access-token.js +33 -0
  22. package/dist/apis/address-suggestions.cjs +33 -0
  23. package/dist/apis/address-suggestions.d.cts +18 -0
  24. package/dist/apis/address-suggestions.d.ts +18 -0
  25. package/dist/apis/address-suggestions.js +33 -0
  26. package/dist/apis/address.cjs +33 -0
  27. package/dist/apis/address.d.cts +18 -0
  28. package/dist/apis/address.d.ts +18 -0
  29. package/dist/apis/address.js +33 -0
  30. package/dist/apis/ai-agents.cjs +33 -0
  31. package/dist/apis/ai-agents.d.cts +18 -0
  32. package/dist/apis/ai-agents.d.ts +18 -0
  33. package/dist/apis/ai-agents.js +33 -0
  34. package/dist/apis/app.cjs +33 -0
  35. package/dist/apis/app.d.cts +18 -0
  36. package/dist/apis/app.d.ts +18 -0
  37. package/dist/apis/app.js +33 -0
  38. package/dist/apis/audit-logs.cjs +33 -0
  39. package/dist/apis/audit-logs.d.cts +18 -0
  40. package/dist/apis/audit-logs.d.ts +18 -0
  41. package/dist/apis/audit-logs.js +33 -0
  42. package/dist/apis/automation.cjs +33 -0
  43. package/dist/apis/automation.d.cts +18 -0
  44. package/dist/apis/automation.d.ts +18 -0
  45. package/dist/apis/automation.js +33 -0
  46. package/dist/apis/billing.cjs +33 -0
  47. package/dist/apis/billing.d.cts +18 -0
  48. package/dist/apis/billing.d.ts +18 -0
  49. package/dist/apis/billing.js +33 -0
  50. package/dist/apis/blueprint-manifest.cjs +33 -0
  51. package/dist/apis/blueprint-manifest.d.cts +18 -0
  52. package/dist/apis/blueprint-manifest.d.ts +18 -0
  53. package/dist/apis/blueprint-manifest.js +33 -0
  54. package/dist/apis/consent.cjs +33 -0
  55. package/dist/apis/consent.d.cts +18 -0
  56. package/dist/apis/consent.d.ts +18 -0
  57. package/dist/apis/consent.js +33 -0
  58. package/dist/apis/customer-portal.cjs +33 -0
  59. package/dist/apis/customer-portal.d.cts +18 -0
  60. package/dist/apis/customer-portal.d.ts +18 -0
  61. package/dist/apis/customer-portal.js +33 -0
  62. package/dist/apis/data-management.cjs +33 -0
  63. package/dist/apis/data-management.d.cts +18 -0
  64. package/dist/apis/data-management.d.ts +18 -0
  65. package/dist/apis/data-management.js +33 -0
  66. package/dist/apis/deduplication.cjs +33 -0
  67. package/dist/apis/deduplication.d.cts +18 -0
  68. package/dist/apis/deduplication.d.ts +18 -0
  69. package/dist/apis/deduplication.js +33 -0
  70. package/dist/apis/design.cjs +33 -0
  71. package/dist/apis/design.d.cts +18 -0
  72. package/dist/apis/design.d.ts +18 -0
  73. package/dist/apis/design.js +33 -0
  74. package/dist/apis/discussion.cjs +33 -0
  75. package/dist/apis/discussion.d.cts +18 -0
  76. package/dist/apis/discussion.d.ts +18 -0
  77. package/dist/apis/discussion.js +33 -0
  78. package/dist/apis/document.cjs +33 -0
  79. package/dist/apis/document.d.cts +18 -0
  80. package/dist/apis/document.d.ts +18 -0
  81. package/dist/apis/document.js +33 -0
  82. package/dist/apis/email-settings.cjs +33 -0
  83. package/dist/apis/email-settings.d.cts +18 -0
  84. package/dist/apis/email-settings.d.ts +18 -0
  85. package/dist/apis/email-settings.js +33 -0
  86. package/dist/apis/email-template.cjs +33 -0
  87. package/dist/apis/email-template.d.cts +18 -0
  88. package/dist/apis/email-template.d.ts +18 -0
  89. package/dist/apis/email-template.js +33 -0
  90. package/dist/apis/entity-mapping.cjs +33 -0
  91. package/dist/apis/entity-mapping.d.cts +18 -0
  92. package/dist/apis/entity-mapping.d.ts +18 -0
  93. package/dist/apis/entity-mapping.js +33 -0
  94. package/dist/apis/entity.cjs +33 -0
  95. package/dist/apis/entity.d.cts +18 -0
  96. package/dist/apis/entity.d.ts +18 -0
  97. package/dist/apis/entity.js +33 -0
  98. package/dist/apis/environments.cjs +33 -0
  99. package/dist/apis/environments.d.cts +18 -0
  100. package/dist/apis/environments.d.ts +18 -0
  101. package/dist/apis/environments.js +33 -0
  102. package/dist/apis/erp-integration.cjs +33 -0
  103. package/dist/apis/erp-integration.d.cts +18 -0
  104. package/dist/apis/erp-integration.d.ts +18 -0
  105. package/dist/apis/erp-integration.js +33 -0
  106. package/dist/apis/event-catalog.cjs +33 -0
  107. package/dist/apis/event-catalog.d.cts +18 -0
  108. package/dist/apis/event-catalog.d.ts +18 -0
  109. package/dist/apis/event-catalog.js +33 -0
  110. package/dist/apis/file.cjs +33 -0
  111. package/dist/apis/file.d.cts +18 -0
  112. package/dist/apis/file.d.ts +18 -0
  113. package/dist/apis/file.js +33 -0
  114. package/dist/apis/iban.cjs +33 -0
  115. package/dist/apis/iban.d.cts +18 -0
  116. package/dist/apis/iban.d.ts +18 -0
  117. package/dist/apis/iban.js +33 -0
  118. package/dist/apis/journey.cjs +33 -0
  119. package/dist/apis/journey.d.cts +18 -0
  120. package/dist/apis/journey.d.ts +18 -0
  121. package/dist/apis/journey.js +33 -0
  122. package/dist/apis/kanban.cjs +33 -0
  123. package/dist/apis/kanban.d.cts +18 -0
  124. package/dist/apis/kanban.d.ts +18 -0
  125. package/dist/apis/kanban.js +33 -0
  126. package/dist/apis/message.cjs +33 -0
  127. package/dist/apis/message.d.cts +18 -0
  128. package/dist/apis/message.d.ts +18 -0
  129. package/dist/apis/message.js +33 -0
  130. package/dist/apis/metering.cjs +33 -0
  131. package/dist/apis/metering.d.cts +18 -0
  132. package/dist/apis/metering.d.ts +18 -0
  133. package/dist/apis/metering.js +33 -0
  134. package/dist/apis/notes.cjs +33 -0
  135. package/dist/apis/notes.d.cts +18 -0
  136. package/dist/apis/notes.d.ts +18 -0
  137. package/dist/apis/notes.js +33 -0
  138. package/dist/apis/notification.cjs +33 -0
  139. package/dist/apis/notification.d.cts +18 -0
  140. package/dist/apis/notification.d.ts +18 -0
  141. package/dist/apis/notification.js +33 -0
  142. package/dist/apis/organization.cjs +33 -0
  143. package/dist/apis/organization.d.cts +18 -0
  144. package/dist/apis/organization.d.ts +18 -0
  145. package/dist/apis/organization.js +33 -0
  146. package/dist/apis/partner-directory.cjs +33 -0
  147. package/dist/apis/partner-directory.d.cts +18 -0
  148. package/dist/apis/partner-directory.d.ts +18 -0
  149. package/dist/apis/partner-directory.js +33 -0
  150. package/dist/apis/permissions.cjs +33 -0
  151. package/dist/apis/permissions.d.cts +18 -0
  152. package/dist/apis/permissions.d.ts +18 -0
  153. package/dist/apis/permissions.js +33 -0
  154. package/dist/apis/pricing-tier.cjs +33 -0
  155. package/dist/apis/pricing-tier.d.cts +18 -0
  156. package/dist/apis/pricing-tier.d.ts +18 -0
  157. package/dist/apis/pricing-tier.js +33 -0
  158. package/dist/apis/pricing.cjs +33 -0
  159. package/dist/apis/pricing.d.cts +18 -0
  160. package/dist/apis/pricing.d.ts +18 -0
  161. package/dist/apis/pricing.js +33 -0
  162. package/dist/apis/purpose.cjs +33 -0
  163. package/dist/apis/purpose.d.cts +18 -0
  164. package/dist/apis/purpose.d.ts +18 -0
  165. package/dist/apis/purpose.js +33 -0
  166. package/dist/apis/sandbox.cjs +33 -0
  167. package/dist/apis/sandbox.d.cts +18 -0
  168. package/dist/apis/sandbox.d.ts +18 -0
  169. package/dist/apis/sandbox.js +33 -0
  170. package/dist/apis/submission.cjs +33 -0
  171. package/dist/apis/submission.d.cts +18 -0
  172. package/dist/apis/submission.d.ts +18 -0
  173. package/dist/apis/submission.js +33 -0
  174. package/dist/apis/targeting.cjs +33 -0
  175. package/dist/apis/targeting.d.cts +18 -0
  176. package/dist/apis/targeting.d.ts +18 -0
  177. package/dist/apis/targeting.js +33 -0
  178. package/dist/apis/template-variables.cjs +33 -0
  179. package/dist/apis/template-variables.d.cts +18 -0
  180. package/dist/apis/template-variables.d.ts +18 -0
  181. package/dist/apis/template-variables.js +33 -0
  182. package/dist/apis/user.cjs +33 -0
  183. package/dist/apis/user.d.cts +18 -0
  184. package/dist/apis/user.d.ts +18 -0
  185. package/dist/apis/user.js +33 -0
  186. package/dist/apis/validation-rules.cjs +33 -0
  187. package/dist/apis/validation-rules.d.cts +18 -0
  188. package/dist/apis/validation-rules.d.ts +18 -0
  189. package/dist/apis/validation-rules.js +33 -0
  190. package/dist/apis/webhooks.cjs +33 -0
  191. package/dist/apis/webhooks.d.cts +18 -0
  192. package/dist/apis/webhooks.d.ts +18 -0
  193. package/dist/apis/webhooks.js +33 -0
  194. package/dist/apis/workflow-definition.cjs +33 -0
  195. package/dist/apis/workflow-definition.d.cts +18 -0
  196. package/dist/apis/workflow-definition.d.ts +18 -0
  197. package/dist/apis/workflow-definition.js +33 -0
  198. package/dist/apis/workflow.cjs +33 -0
  199. package/dist/apis/workflow.d.cts +18 -0
  200. package/dist/apis/workflow.d.ts +18 -0
  201. package/dist/apis/workflow.js +33 -0
  202. package/dist/app-UUTBO3WJ.js +573 -0
  203. package/dist/app-XJGY6SHO.cjs +573 -0
  204. package/dist/app.d-Uncn387s.d.cts +3370 -0
  205. package/dist/app.d-Uncn387s.d.ts +3370 -0
  206. package/dist/audit-logs-4IJYIOXF.js +55 -0
  207. package/dist/audit-logs-UWLCPBB4.cjs +55 -0
  208. package/dist/audit-logs.d-BxZqONu5.d.cts +288 -0
  209. package/dist/audit-logs.d-BxZqONu5.d.ts +288 -0
  210. package/dist/automation-4UQADTDO.cjs +282 -0
  211. package/dist/automation-PVXTQLZX.js +282 -0
  212. package/dist/automation.d-BteCzeFn.d.cts +4921 -0
  213. package/dist/automation.d-BteCzeFn.d.ts +4921 -0
  214. package/dist/billing-FI4V4UX5.cjs +175 -0
  215. package/dist/billing-OMWNJHGW.js +175 -0
  216. package/dist/billing.d-BH4__05Y.d.cts +994 -0
  217. package/dist/billing.d-BH4__05Y.d.ts +994 -0
  218. package/dist/bin/cli.js +135 -0
  219. package/dist/blueprint-manifest-CPQAL76N.cjs +504 -0
  220. package/dist/blueprint-manifest-FIMGDHSH.js +504 -0
  221. package/dist/blueprint-manifest.d-CU4v09fj.d.cts +3327 -0
  222. package/dist/blueprint-manifest.d-CU4v09fj.d.ts +3327 -0
  223. package/dist/chunk-3RG5ZIWI.js +10 -0
  224. package/dist/chunk-OBGZSXTJ.cjs +10 -0
  225. package/dist/chunk-UJTFRZMS.js +65 -0
  226. package/dist/chunk-YLLKMXS3.cjs +65 -0
  227. package/dist/consent-NHDCDJMK.js +84 -0
  228. package/dist/consent-R5GU3WCK.cjs +84 -0
  229. package/dist/consent.d-BETWwU_2.d.cts +266 -0
  230. package/dist/consent.d-BETWwU_2.d.ts +266 -0
  231. package/dist/customer-portal-6AV2W43T.cjs +2252 -0
  232. package/dist/customer-portal-EY57GJYV.js +2252 -0
  233. package/dist/customer-portal.d-Co_I6psR.d.cts +15255 -0
  234. package/dist/customer-portal.d-Co_I6psR.d.ts +15255 -0
  235. package/dist/data-management-ILQUYNTN.cjs +240 -0
  236. package/dist/data-management-QMXOLOEG.js +240 -0
  237. package/dist/data-management.d-CkR2E_Pm.d.cts +548 -0
  238. package/dist/data-management.d-CkR2E_Pm.d.ts +548 -0
  239. package/dist/deduplication-IVXANO7S.cjs +42 -0
  240. package/dist/deduplication-WN45DVK3.js +42 -0
  241. package/dist/deduplication.d-BlHnjhXk.d.cts +114 -0
  242. package/dist/deduplication.d-BlHnjhXk.d.ts +114 -0
  243. package/dist/design-ONRLY6XI.cjs +219 -0
  244. package/dist/design-UHMRO3PG.js +219 -0
  245. package/dist/design.d-JsNY_cGh.d.cts +834 -0
  246. package/dist/design.d-JsNY_cGh.d.ts +834 -0
  247. package/dist/discussion-4CZIG3ZM.cjs +134 -0
  248. package/dist/discussion-VWMWL2AF.js +134 -0
  249. package/dist/discussion.d-CxxaYKTf.d.cts +580 -0
  250. package/dist/discussion.d-CxxaYKTf.d.ts +580 -0
  251. package/dist/document-CN3JNXFF.js +78 -0
  252. package/dist/document-PCKNZA4K.cjs +78 -0
  253. package/dist/document.d-CZ_FGhEn.d.cts +649 -0
  254. package/dist/document.d-CZ_FGhEn.d.ts +649 -0
  255. package/dist/email-settings-ANURQMKZ.js +533 -0
  256. package/dist/email-settings-YE2XB2ZU.cjs +533 -0
  257. package/dist/email-settings.d-3eXYEyRr.d.cts +2278 -0
  258. package/dist/email-settings.d-3eXYEyRr.d.ts +2278 -0
  259. package/dist/email-template-4QI4YS4J.js +122 -0
  260. package/dist/email-template-BUJBC6HH.cjs +122 -0
  261. package/dist/email-template.d-C2L0dKqB.d.cts +1175 -0
  262. package/dist/email-template.d-C2L0dKqB.d.ts +1175 -0
  263. package/dist/entity-BCFE3UJT.cjs +1600 -0
  264. package/dist/entity-VEXNQC4Y.js +1600 -0
  265. package/dist/entity-mapping-PHRLSYP7.cjs +215 -0
  266. package/dist/entity-mapping-QK7MGNAW.js +215 -0
  267. package/dist/entity-mapping.d-B3Vyepok.d.cts +1093 -0
  268. package/dist/entity-mapping.d-B3Vyepok.d.ts +1093 -0
  269. package/dist/entity.d-DmER_7q5.d.cts +16018 -0
  270. package/dist/entity.d-DmER_7q5.d.ts +16018 -0
  271. package/dist/environments-266S44UM.cjs +71 -0
  272. package/dist/environments-AV7W6SLT.js +71 -0
  273. package/dist/environments.d-CpILpSNF.d.cts +254 -0
  274. package/dist/environments.d-CpILpSNF.d.ts +254 -0
  275. package/dist/erp-integration-5WNBCGWS.cjs +586 -0
  276. package/dist/erp-integration-EMI5WIWA.js +586 -0
  277. package/dist/erp-integration.d-DmxUZOUQ.d.cts +4120 -0
  278. package/dist/erp-integration.d-DmxUZOUQ.d.ts +4120 -0
  279. package/dist/event-catalog-DBWYKQ6J.cjs +130 -0
  280. package/dist/event-catalog-KKMXV5LB.js +130 -0
  281. package/dist/event-catalog.d-B2tq20gn.d.cts +1512 -0
  282. package/dist/event-catalog.d-B2tq20gn.d.ts +1512 -0
  283. package/dist/file-3ZLMS6TL.js +573 -0
  284. package/dist/file-Q66N5XMG.cjs +573 -0
  285. package/dist/file.d-Bi0EZkNu.d.cts +2993 -0
  286. package/dist/file.d-Bi0EZkNu.d.ts +2993 -0
  287. package/dist/iban-HSXVSIFW.cjs +43 -0
  288. package/dist/iban-Q27INTOC.js +43 -0
  289. package/dist/iban.d-DP7hl0Qt.d.cts +71 -0
  290. package/dist/iban.d-DP7hl0Qt.d.ts +71 -0
  291. package/dist/index.cjs +563 -0
  292. package/dist/index.d.cts +119 -0
  293. package/dist/index.d.ts +119 -0
  294. package/dist/index.js +563 -0
  295. package/dist/journey-DGKXVWZQ.js +270 -0
  296. package/dist/journey-T2Y72EBS.cjs +270 -0
  297. package/dist/journey.d-DxL16X6N.d.cts +1794 -0
  298. package/dist/journey.d-DxL16X6N.d.ts +1794 -0
  299. package/dist/kanban-A4B6RCJ2.cjs +164 -0
  300. package/dist/kanban-PP6WJVT2.js +164 -0
  301. package/dist/kanban.d-DDrBwr9h.d.cts +631 -0
  302. package/dist/kanban.d-DDrBwr9h.d.ts +631 -0
  303. package/dist/message-D6JY4GJH.cjs +673 -0
  304. package/dist/message-HFX2DDCV.js +673 -0
  305. package/dist/message.d-BeBH6vof.d.cts +3580 -0
  306. package/dist/message.d-BeBH6vof.d.ts +3580 -0
  307. package/dist/metering-63MJFCS2.cjs +399 -0
  308. package/dist/metering-F63PNFCZ.js +399 -0
  309. package/dist/metering.d-D5VR4tVa.d.cts +1842 -0
  310. package/dist/metering.d-D5VR4tVa.d.ts +1842 -0
  311. package/dist/notes-FTL5H4JE.cjs +219 -0
  312. package/dist/notes-GMWTQCMB.js +219 -0
  313. package/dist/notes.d-DZYeVo0I.d.cts +1047 -0
  314. package/dist/notes.d-DZYeVo0I.d.ts +1047 -0
  315. package/dist/notification-WXFSOORN.cjs +237 -0
  316. package/dist/notification-XHG3TIBW.js +237 -0
  317. package/dist/notification.d-BJwdFZnG.d.cts +1148 -0
  318. package/dist/notification.d-BJwdFZnG.d.ts +1148 -0
  319. package/dist/organization-CPXTUDJO.js +118 -0
  320. package/dist/organization-XIFV7MWP.cjs +118 -0
  321. package/dist/organization.d-DfUcuwKM.d.cts +629 -0
  322. package/dist/organization.d-DfUcuwKM.d.ts +629 -0
  323. package/dist/partner-directory-4WCHPJRO.js +282 -0
  324. package/dist/partner-directory-FKWPPO7F.cjs +282 -0
  325. package/dist/partner-directory.d-BRRDHFcz.d.cts +1511 -0
  326. package/dist/partner-directory.d-BRRDHFcz.d.ts +1511 -0
  327. package/dist/permissions-5E36GPG3.js +178 -0
  328. package/dist/permissions-PBTK5CCD.cjs +178 -0
  329. package/dist/permissions.d-CL7SwMFy.d.cts +1253 -0
  330. package/dist/permissions.d-CL7SwMFy.d.ts +1253 -0
  331. package/dist/pricing-FDWEBIQU.js +439 -0
  332. package/dist/pricing-FZQKL4DW.cjs +439 -0
  333. package/dist/pricing-tier-34O624R4.js +36 -0
  334. package/dist/pricing-tier-F4HE6WIM.cjs +36 -0
  335. package/dist/pricing-tier.d-VuH-NtlR.d.cts +82 -0
  336. package/dist/pricing-tier.d-VuH-NtlR.d.ts +82 -0
  337. package/dist/pricing.d-Dd1CaSX_.d.cts +12201 -0
  338. package/dist/pricing.d-Dd1CaSX_.d.ts +12201 -0
  339. package/dist/purpose-47HJIG2Q.cjs +180 -0
  340. package/dist/purpose-MX33NU5H.js +180 -0
  341. package/dist/purpose.d-D8YCSqt9.d.cts +373 -0
  342. package/dist/purpose.d-D8YCSqt9.d.ts +373 -0
  343. package/dist/sandbox-7QNLGFN2.cjs +100 -0
  344. package/dist/sandbox-TZCXHBJN.js +100 -0
  345. package/dist/sandbox.d-D1NgPMEc.d.cts +466 -0
  346. package/dist/sandbox.d-D1NgPMEc.d.ts +466 -0
  347. package/dist/submission-6LSPBI27.js +55 -0
  348. package/dist/submission-DBQNDJ4B.cjs +55 -0
  349. package/dist/submission.d-e9MPrbY1.d.cts +470 -0
  350. package/dist/submission.d-e9MPrbY1.d.ts +470 -0
  351. package/dist/targeting-HZRCLNIF.cjs +275 -0
  352. package/dist/targeting-MTQ6JBCY.js +275 -0
  353. package/dist/targeting.d-1GW3nh-y.d.cts +2058 -0
  354. package/dist/targeting.d-1GW3nh-y.d.ts +2058 -0
  355. package/dist/template-variables-S6IXK7SF.js +159 -0
  356. package/dist/template-variables-VPNIMC7L.cjs +159 -0
  357. package/dist/template-variables.d-CqqGe3sd.d.cts +1315 -0
  358. package/dist/template-variables.d-CqqGe3sd.d.ts +1315 -0
  359. package/dist/types-C5cGIwtq.d.cts +28 -0
  360. package/dist/types-C5cGIwtq.d.ts +28 -0
  361. package/dist/user-BHH4DAA5.cjs +488 -0
  362. package/dist/user-KBXFVRPI.js +488 -0
  363. package/dist/user.d-CWBgUia2.d.cts +2199 -0
  364. package/dist/user.d-CWBgUia2.d.ts +2199 -0
  365. package/dist/validation-rules-4V7KAWGW.cjs +120 -0
  366. package/dist/validation-rules-UGQY4ASY.js +120 -0
  367. package/dist/validation-rules.d-CMSvveua.d.cts +808 -0
  368. package/dist/validation-rules.d-CMSvveua.d.ts +808 -0
  369. package/dist/webhooks-JR475VD4.js +252 -0
  370. package/dist/webhooks-X64U3KCB.cjs +252 -0
  371. package/dist/webhooks.d-Bzl-u_Zs.d.cts +1201 -0
  372. package/dist/webhooks.d-Bzl-u_Zs.d.ts +1201 -0
  373. package/dist/workflow-7ANPQZDP.cjs +402 -0
  374. package/dist/workflow-DWSAHA5Q.js +402 -0
  375. package/dist/workflow-definition-2M3JBCUI.cjs +342 -0
  376. package/dist/workflow-definition-WLPGEU55.js +342 -0
  377. package/dist/workflow-definition.d-BKmIy2Qp.d.cts +2030 -0
  378. package/dist/workflow-definition.d-BKmIy2Qp.d.ts +2030 -0
  379. package/dist/workflow.d-DElz0XoQ.d.cts +3017 -0
  380. package/dist/workflow.d-DElz0XoQ.d.ts +3017 -0
  381. package/package.json +289 -0
@@ -0,0 +1,4921 @@
1
+ import { OpenAPIClient, Parameters, AxiosRequestConfig, OperationResponse, UnknownParamsObject } from 'openapi-client-axios';
2
+
3
+ /* eslint-disable */
4
+ /* Auto-copied from automation-client */
5
+ /* eslint-disable */
6
+
7
+
8
+
9
+ declare namespace Components {
10
+ namespace Responses {
11
+ /**
12
+ * example:
13
+ * {
14
+ * "status": 403,
15
+ * "error": "Forbidden"
16
+ * }
17
+ */
18
+ export interface ForbiddenError {
19
+ /**
20
+ * The HTTP status code of the error
21
+ * example:
22
+ * 400
23
+ */
24
+ status?: number;
25
+ /**
26
+ * The error message
27
+ */
28
+ error?: string;
29
+ }
30
+ /**
31
+ * example:
32
+ * {
33
+ * "status": 404,
34
+ * "error": "Not Found"
35
+ * }
36
+ */
37
+ export interface NotFoundError {
38
+ /**
39
+ * The HTTP status code of the error
40
+ * example:
41
+ * 400
42
+ */
43
+ status?: number;
44
+ /**
45
+ * The error message
46
+ */
47
+ error?: string;
48
+ }
49
+ }
50
+ namespace Schemas {
51
+ export interface ActionCondition {
52
+ id?: string;
53
+ /**
54
+ * Schedule Id which indicates the schedule of the actions inside the condition
55
+ */
56
+ schedule_id?: string;
57
+ /**
58
+ * Result of the condition evaluation
59
+ */
60
+ evaluationResult?: boolean;
61
+ statements?: /**
62
+ * example:
63
+ * {
64
+ * "source": {
65
+ * "origin": "trigger",
66
+ * "originType": "entity",
67
+ * "id": "trigger-id",
68
+ * "schema": "contact",
69
+ * "attribute": "email",
70
+ * "attributeType": "text"
71
+ * },
72
+ * "operation": "equals",
73
+ * "values": [
74
+ * "hello@epilot.cloud"
75
+ * ]
76
+ * }
77
+ */
78
+ ConditionStatement[];
79
+ }
80
+ export interface ActionSchedule {
81
+ /**
82
+ * Schedule Id
83
+ */
84
+ id: string;
85
+ /**
86
+ * The id of the configured scheduler which will be added on automation triggered
87
+ */
88
+ scheduleApiId?: string;
89
+ numberOfUnits?: number;
90
+ timePeriod?: "minutes" | "hours" | "days" | "weeks" | "months";
91
+ timeRelation?: "after" | "before";
92
+ source: /* The source of the schedule_at timestamp that will be used to schedule the action */ ActionScheduleSource;
93
+ }
94
+ /**
95
+ * The source of the schedule_at timestamp that will be used to schedule the action
96
+ */
97
+ export interface ActionScheduleSource {
98
+ /**
99
+ * The id of the action or trigger
100
+ */
101
+ id: string;
102
+ origin: "trigger" | "action" | "action_task" | "automation";
103
+ schema?: string;
104
+ attribute?: string;
105
+ }
106
+ /**
107
+ * example:
108
+ * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
109
+ */
110
+ export type ActivityId = string;
111
+ export interface ActivityTrigger {
112
+ /**
113
+ * example:
114
+ * 12d4f45a-1883-4841-a94c-5928cb338a94
115
+ */
116
+ id?: string; // uuid
117
+ type: "activity";
118
+ configuration: {
119
+ /**
120
+ * example:
121
+ * submission
122
+ */
123
+ schema?: string;
124
+ types?: (("CreateMeterReading" | "UpdateMeterReading" | "DocDownloadedFromPortal" | "PortalUserResetPassword" | "PortalUserResetForgotPassword" | "SelfAssignmentFromPortal") | string)[];
125
+ };
126
+ }
127
+ export type AnyAction = MapEntityAction | TriggerWorkflowAction | TriggerShareEntityAction | TriggerWebhookAction | InformERPAction | TriggerEventAction | CreateDocumentAction | SendEmailAction | /* Creates an order entity with prices from journey */ CartCheckoutAction | CustomAction | AutomationAction | FlowExecutionCancelAction;
128
+ export type AnyActionConfig = /**
129
+ * example:
130
+ * {
131
+ * "id": "2520gja-2sgmsaga-0asg-822jgal",
132
+ * "name": "Map Entity",
133
+ * "type": "map-entity",
134
+ * "config": {
135
+ * "target_schema": "contact",
136
+ * "target_unique": [
137
+ * "email.0.email"
138
+ * ],
139
+ * "relation_attributes": [
140
+ * {
141
+ * "target": "company",
142
+ * "mode": "append",
143
+ * "source_filter": {
144
+ * "schema": "account",
145
+ * "limit": 1
146
+ * }
147
+ * }
148
+ * ],
149
+ * "mapping_attributes": [
150
+ * {
151
+ * "target": "_tags",
152
+ * "operation": {
153
+ * "_append": [
154
+ * "primary",
155
+ * "payer"
156
+ * ],
157
+ * "_uniq": true
158
+ * }
159
+ * },
160
+ * {
161
+ * "target": "email",
162
+ * "operation": {
163
+ * "_append": [
164
+ * {
165
+ * "email": {
166
+ * "_copy": "billing_contact.email"
167
+ * }
168
+ * }
169
+ * ]
170
+ * }
171
+ * },
172
+ * {
173
+ * "target": "first_name",
174
+ * "operation": {
175
+ * "_copy": "billing_contact.first_name"
176
+ * }
177
+ * },
178
+ * {
179
+ * "target": "last_name",
180
+ * "operation": {
181
+ * "_copy": "billing_contact.last_name"
182
+ * }
183
+ * },
184
+ * {
185
+ * "target": "contact_type",
186
+ * "operation": {
187
+ * "_set": "customer"
188
+ * }
189
+ * },
190
+ * {
191
+ * "target": "address",
192
+ * "operation": {
193
+ * "_append": [
194
+ * {
195
+ * "_tags": [
196
+ * "billing",
197
+ * "primary"
198
+ * ],
199
+ * "street_name": {
200
+ * "_copy": "billing_contact.street_name"
201
+ * },
202
+ * "street_number": {
203
+ * "_copy": "billing_contact.street_number"
204
+ * },
205
+ * "city": {
206
+ * "_copy": "billing_contact.city"
207
+ * },
208
+ * "postal_code": {
209
+ * "_copy": "billing_contact.postal_code"
210
+ * },
211
+ * "country": {
212
+ * "_copy": "billing_contact.country"
213
+ * }
214
+ * },
215
+ * {
216
+ * "_tags": [
217
+ * "delivery"
218
+ * ],
219
+ * "street_name": {
220
+ * "_copy": "delivery_contact.street_name"
221
+ * },
222
+ * "street_number": {
223
+ * "_copy": "delivery_contact.street_number"
224
+ * },
225
+ * "city": {
226
+ * "_copy": "delivery_contact.city"
227
+ * },
228
+ * "postal_code": {
229
+ * "_copy": "delivery_contact.postal_code"
230
+ * },
231
+ * "country": {
232
+ * "_copy": "delivery_contact.country"
233
+ * }
234
+ * }
235
+ * ],
236
+ * "_uniq": [
237
+ * "street_name",
238
+ * "street_number",
239
+ * "postal_code",
240
+ * "country"
241
+ * ]
242
+ * }
243
+ * }
244
+ * ]
245
+ * }
246
+ * }
247
+ */
248
+ MapEntityActionConfig | /**
249
+ * example:
250
+ * {
251
+ * "id": "08g988-ojt2jtaga-292h-8978gsaga",
252
+ * "name": "Trigger Workflow",
253
+ * "type": "trigger-workflow",
254
+ * "config": {
255
+ * "target_workflow": "mfptvUMH",
256
+ * "conditions": [
257
+ * {
258
+ * "schema": "ivy-opportunity",
259
+ * "source": "customer.type",
260
+ * "comparison": "equals",
261
+ * "value": "PRIVATE"
262
+ * }
263
+ * ],
264
+ * "assign_steps": [
265
+ * {
266
+ * "step_name": "Lead Sales",
267
+ * "user_ids": [
268
+ * 10010729
269
+ * ]
270
+ * },
271
+ * {
272
+ * "step_name": "Operations",
273
+ * "user_ids": [
274
+ * 10010728,
275
+ * 10010729
276
+ * ]
277
+ * }
278
+ * ]
279
+ * }
280
+ * }
281
+ */
282
+ TriggerWorkflowActionConfig | TriggerShareEntityActionConfig | /**
283
+ * example:
284
+ * {
285
+ * "id": "2520gja-2sgmsaga-0asg-822jgal",
286
+ * "name": "Trigger Webhook",
287
+ * "type": "trigger-webhook",
288
+ * "config": {
289
+ * "entity_sources": [
290
+ * "contact",
291
+ * "account"
292
+ * ],
293
+ * "target_webhook_id": "25jg9ag2ga"
294
+ * }
295
+ * }
296
+ */
297
+ TriggerWebhookActionConfig | /**
298
+ * example:
299
+ * {
300
+ * "id": "2520gja-2sgmsaga-0asg-822jgal",
301
+ * "name": "Inform ERP",
302
+ * "type": "inform-erp",
303
+ * "config": {
304
+ * "entity_sources": [
305
+ * "contact",
306
+ * "account"
307
+ * ],
308
+ * "target_webhook_id": "25jg9ag2ga"
309
+ * }
310
+ * }
311
+ */
312
+ InformERPActionConfig | /**
313
+ * example:
314
+ * {
315
+ * "id": "2520gja-2sgmsaga-0asg-822jgal",
316
+ * "name": "Trigger Event",
317
+ * "type": "trigger-event",
318
+ * "config": {
319
+ * "event_name": "my_custom_event",
320
+ * "event_inputs": {
321
+ * "key": "value"
322
+ * }
323
+ * }
324
+ * }
325
+ */
326
+ TriggerEventActionConfig | /**
327
+ * example:
328
+ * {
329
+ * "id": "08g988-ojt2jtaga-292h-8978gsaga",
330
+ * "name": "Create Document",
331
+ * "type": "create-document",
332
+ * "config": {
333
+ * "template_id": {
334
+ * "type": "string",
335
+ * "example": "112b08ba-789c-42f2-9940-43b302f641e8\""
336
+ * },
337
+ * "filename": {
338
+ * "type": "string",
339
+ * "example": "newsletter.pdf\""
340
+ * }
341
+ * }
342
+ * }
343
+ */
344
+ CreateDocumentActionConfig | /**
345
+ * example:
346
+ * {
347
+ * "id": "25jga0-gkasl26-0asg-908sgaj2",
348
+ * "name": "Send Email",
349
+ * "type": "send-email",
350
+ * "config": {
351
+ * "email_template_id": "gasj02-29ug9asgm-29t9gsaghg2g-pkmbhx2",
352
+ * "language_code": "de"
353
+ * }
354
+ * }
355
+ */
356
+ SendEmailActionConfig | /* Creates an order entity with prices from journey */ CartCheckoutActionConfig | CustomAction | AutomationActionConfig | /**
357
+ * example:
358
+ * {
359
+ * "id": "2520gja-2sgmsaga-0asg-822jgal",
360
+ * "name": "Cancel Flow Execution",
361
+ * "type": "cancel-flow-execution",
362
+ * "config": {
363
+ * "selected_reasons": [
364
+ * {
365
+ * "id": "_6kITMwkv_0Uo4i7fO7Ja",
366
+ * "title": "when you are done! that's when you close it."
367
+ * },
368
+ * {
369
+ * "id": "qgK9sGbKoS7NxlAbNReVn",
370
+ * "title": "Client didn't want our services"
371
+ * }
372
+ * ],
373
+ * "extra_description": "Test cancellation"
374
+ * }
375
+ * }
376
+ */
377
+ FlowExecutionCancelActionConfig;
378
+ export type AnyTrigger = FrontendSubmitTrigger | JourneySubmitTrigger | ApiSubmissionTrigger | /**
379
+ * - If provides filter_config, executes an automation based on the filtered configuration when an entity event occurs.
380
+ * - The conditions on a filter follows the event bridge patterns - `https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html`
381
+ * | Comparison | Example | Rule syntax |
382
+ * |------------------------|-----------------------------------------------------|----------------------------------------------------------|
383
+ * | Null | first_name is null | `"first_name": [ null ]` |
384
+ * | Empty | last_name is empty | `"last_name": [""]` |
385
+ * | Equals | email is "j.doe@email.com" | `"email": [ "j.doe@email.com" ]` |
386
+ * | Equals (ignore case) | first_name is "John" | `"first_name": [ { "equals-ignore-case": "john" } ]` |
387
+ * | And | fist_name is "John" and last_name is "Doe" | `"first_name": [ "John" ], "last_name": ["Doe"]` |
388
+ * | Or | PaymentType is "Invoice" or "SEPA" | `"PaymentType": [ "invoice", "sepa"]` |
389
+ * | Or (multiple fields) | first_name is "John", or last_name is "Doe". | `"$or": [ { "first_name": [ "John" ] }, { "last_name": [ "Doe" ] } ]` |
390
+ * | Not | status is anything but "cancelled" | `"status": [ { "anything-but": [ "cancelled" ] } ]` |
391
+ * | Numeric (equals) | Price is 100 | `"Price": [ { "numeric": [ "=", 100 ] } ]` |
392
+ * | Numeric (range) | Price is more than 10, and less than or equal to 20 | `"Price": [ { "numeric": [ ">", 10, "<=", 20 ] } ]` |
393
+ * | Exists | ProductName exists | `"ProductName": [ { "exists": true } ]` |
394
+ * | Does not exist | ProductName does not exist | `"ProductName": [ { "exists": false } ]` |
395
+ * | Begins with | OpportunityNumber starts with OPP- | `"opportunity_number": [ { "prefix": "OPP-" } ]` |
396
+ * | Ends with | FileName ends with a .png extension | `"filename": [ { "suffix": ".png" } ]` |
397
+ * | Wildcard | search a string using a wildcard | `"email": [ { "wildcard": "*@doe.com" } ]` |
398
+ * - To run the execution on all update events
399
+ * ```
400
+ * {
401
+ * "type": "filter_entity_event",
402
+ * "configuration": {
403
+ * "operation": {
404
+ * "operation": ["updateEntity"]
405
+ * }
406
+ * }
407
+ * }
408
+ * ```
409
+ * - To run the execution only when the updates are from a portal user
410
+ * ```
411
+ * {
412
+ * "type": "filter_entity_event",
413
+ * "configuration": {
414
+ * "operation": {
415
+ * "operation": ["updateEntity"]
416
+ * },
417
+ * "activity": {
418
+ * "type": "EntityUpdatedFromPortal"
419
+ * }
420
+ * }
421
+ * }
422
+ * ```
423
+ * - To run the execution only when there is an update on a specific attribute
424
+ * ```
425
+ * Only starts the automation when the email on a contact is changed
426
+ * {
427
+ * "type": "filter_entity_event",
428
+ * "configuration": {
429
+ * "operation": {
430
+ * "operation": ["updateEntity"],
431
+ * "payload": {
432
+ * "_schema": ["contact"]
433
+ * },
434
+ * "diff": {
435
+ * "updated": {
436
+ * "email": [{ "exists": true }]
437
+ * }
438
+ * }
439
+ * }
440
+ * }
441
+ * }
442
+ * ```
443
+ * - To run the execution only when a specific attribute is altered(created/updated/deleted)
444
+ * ```
445
+ * Only starts the automation when a price is altered on a contract
446
+ * {
447
+ * "type": "filter_entity_event",
448
+ * "configuration": {
449
+ * "operation": {
450
+ * "payload": {
451
+ * "_schema": ["contract"]
452
+ * },
453
+ * "diff": {
454
+ * // Whether he first_name has been added, updated, or removed
455
+ * $or: [
456
+ * {
457
+ * 'added.first_name': [{ exists: true }]
458
+ * },
459
+ * {
460
+ * 'updated.first_name': [{ exists: true }]
461
+ * },
462
+ * {
463
+ * 'deleted.first_name': [{ exists: true }]
464
+ * }
465
+ * ]
466
+ * }
467
+ * }
468
+ * }
469
+ * }
470
+ * ```
471
+ * - To run the execution if an attribute is changed from one state to another
472
+ * ```
473
+ * Only starts the automation when the order status changes from `open_for_acceptance` to `placed`
474
+ * {
475
+ * "type": "filter_entity_event",
476
+ * "configuration": {
477
+ * "operation": {
478
+ * "operation": ["updateEntity"],
479
+ * "payload": {
480
+ * "_schema": ["order"],
481
+ * "status": ["placed"]
482
+ * },
483
+ * "diff": {
484
+ * "updated": {
485
+ * "status": ["open_for_acceptance"]
486
+ * }
487
+ * }
488
+ * }
489
+ * }
490
+ * }
491
+ * ```
492
+ *
493
+ */
494
+ EntityOperationTrigger | ActivityTrigger | EntityManualTrigger | ReceivedEmailTrigger | NewEmailThreadTrigger | FlowsTrigger;
495
+ export interface AnythingButCondition {
496
+ "anything-but"?: string[];
497
+ }
498
+ export interface ApiCallerContext {
499
+ [name: string]: any;
500
+ EpilotAuth?: {
501
+ /**
502
+ * example:
503
+ * {
504
+ * "sub": "476e9b48-42f4-4234-a2b0-4668b34626ce",
505
+ * "iss": "https://cognito-idp.eu-central-1.amazonaws.com/eu-central-1_6lZSgmU6D",
506
+ * "custom:ivy_org_id": "739224",
507
+ * "cognito:username": "n.ahmad@epilot.cloud",
508
+ * "custom:ivy_user_id": "10006129",
509
+ * "aud": "6e0jbdnger7nmoktaaflarue1l",
510
+ * "event_id": "cd5f5583-d90c-4db5-8e99-5f5dd29a4d75",
511
+ * "token_use": "id",
512
+ * "auth_time": 1614333023,
513
+ * "exp": 1614336623,
514
+ * "iat": 1614333023,
515
+ * "email": "n.ahmad@epilot.cloud"
516
+ * }
517
+ */
518
+ claims?: {
519
+ /**
520
+ * example:
521
+ * 10006129
522
+ */
523
+ userId?: string;
524
+ /**
525
+ * example:
526
+ * 476e9b48-42f4-4234-a2b0-4668b34626ce
527
+ */
528
+ sub?: string;
529
+ /**
530
+ * example:
531
+ * example@epilot.cloud
532
+ */
533
+ email?: string;
534
+ /**
535
+ * example:
536
+ * example@epilot.cloud
537
+ */
538
+ "cognito:username"?: string;
539
+ /**
540
+ * example:
541
+ * 10006129
542
+ */
543
+ "custom:ivy_user_id"?: string;
544
+ };
545
+ /**
546
+ * example:
547
+ * 10006129
548
+ */
549
+ userId?: string;
550
+ /**
551
+ * example:
552
+ * 739224
553
+ */
554
+ organizationId?: string;
555
+ /**
556
+ * example:
557
+ * eyJraWQiOi...
558
+ */
559
+ token?: string;
560
+ };
561
+ }
562
+ export interface ApiSubmissionTrigger {
563
+ /**
564
+ * example:
565
+ * 12d4f45a-1883-4841-a94c-5928cb338a94
566
+ */
567
+ id?: string; // uuid
568
+ type: "api_submission";
569
+ configuration: {
570
+ source_id?: string;
571
+ };
572
+ }
573
+ export interface AppendValueMapper {
574
+ mode: /**
575
+ * - 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 together with value property.
576
+ *
577
+ */
578
+ MappingAttributeMode;
579
+ /**
580
+ * JSON like target path for the attribute. Eg. last_name
581
+ */
582
+ target: string;
583
+ /**
584
+ * JSON source path for the value to be extracted from the main entity. Eg: steps[1].['Product Info'].price
585
+ *
586
+ */
587
+ source?: string;
588
+ /**
589
+ * To be provided only when mapping json objects into a target attribute. Eg array of addresses.
590
+ *
591
+ */
592
+ value_json: string;
593
+ /**
594
+ * Array of keys which should be used when checking for uniqueness. Eg: [country, city, postal_code]
595
+ *
596
+ */
597
+ target_unique?: string[];
598
+ }
599
+ export interface AssignThreadAction {
600
+ id?: /**
601
+ * example:
602
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
603
+ */
604
+ AutomationActionId;
605
+ flow_action_id?: /**
606
+ * example:
607
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
608
+ */
609
+ AutomationActionId;
610
+ name?: string;
611
+ type?: "assign-thread";
612
+ config?: AssignThreadConfig;
613
+ /**
614
+ * Whether to stop execution in a failed state if this action fails
615
+ */
616
+ allow_failure?: boolean;
617
+ /**
618
+ * Flag indicating whether the action was created automatically or manually
619
+ */
620
+ created_automatically?: boolean;
621
+ /**
622
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
623
+ */
624
+ is_bulk_action?: boolean;
625
+ reason?: {
626
+ /**
627
+ * Why the action has to be skipped/failed
628
+ * example:
629
+ * There are no registered portal users for the given emails, hence skipping the action
630
+ */
631
+ message?: string;
632
+ /**
633
+ * Extra metadata about the skipping reason - such as a certain condition not met, etc.
634
+ */
635
+ payload?: {
636
+ [name: string]: any;
637
+ };
638
+ };
639
+ /**
640
+ * Condition Id to be checked before executing the action
641
+ */
642
+ condition_id?: string;
643
+ /**
644
+ * Schedule Id which indicates the schedule of the action
645
+ */
646
+ schedule_id?: string;
647
+ execution_status?: ExecutionStatus;
648
+ started_at?: string;
649
+ updated_at?: string;
650
+ /**
651
+ * example:
652
+ * {}
653
+ */
654
+ outputs?: {
655
+ [name: string]: any;
656
+ };
657
+ error_output?: ErrorOutput;
658
+ retry_strategy?: /* different behaviors for retrying failed execution actions. */ RetryStrategy;
659
+ }
660
+ export interface AssignThreadConfig {
661
+ /**
662
+ * Assignees to remove from the thread, if they exist
663
+ */
664
+ remove?: string[];
665
+ /**
666
+ * Assignees to add to the thread
667
+ */
668
+ add?: string[];
669
+ }
670
+ /**
671
+ * example:
672
+ * [
673
+ * {
674
+ * "step_id": "xyh9t2ha",
675
+ * "step_name": "Lead Sales",
676
+ * "user_ids": [
677
+ * 10010729
678
+ * ]
679
+ * },
680
+ * {
681
+ * "step_id": "29jgasl",
682
+ * "step_name": "Operations",
683
+ * "user_ids": [
684
+ * 10010728,
685
+ * 10010729
686
+ * ]
687
+ * }
688
+ * ]
689
+ */
690
+ export interface AssignUsersToStep {
691
+ step_id?: string;
692
+ step_name?: string;
693
+ user_ids?: number[];
694
+ }
695
+ export interface AutomationAction {
696
+ id?: /**
697
+ * example:
698
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
699
+ */
700
+ AutomationActionId;
701
+ flow_action_id?: /**
702
+ * example:
703
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
704
+ */
705
+ AutomationActionId;
706
+ name?: string;
707
+ type?: string;
708
+ config?: {
709
+ [name: string]: any;
710
+ };
711
+ /**
712
+ * Whether to stop execution in a failed state if this action fails
713
+ */
714
+ allow_failure?: boolean;
715
+ /**
716
+ * Flag indicating whether the action was created automatically or manually
717
+ */
718
+ created_automatically?: boolean;
719
+ /**
720
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
721
+ */
722
+ is_bulk_action?: boolean;
723
+ reason?: {
724
+ /**
725
+ * Why the action has to be skipped/failed
726
+ * example:
727
+ * There are no registered portal users for the given emails, hence skipping the action
728
+ */
729
+ message?: string;
730
+ /**
731
+ * Extra metadata about the skipping reason - such as a certain condition not met, etc.
732
+ */
733
+ payload?: {
734
+ [name: string]: any;
735
+ };
736
+ };
737
+ /**
738
+ * Condition Id to be checked before executing the action
739
+ */
740
+ condition_id?: string;
741
+ /**
742
+ * Schedule Id which indicates the schedule of the action
743
+ */
744
+ schedule_id?: string;
745
+ execution_status?: ExecutionStatus;
746
+ started_at?: string;
747
+ updated_at?: string;
748
+ /**
749
+ * example:
750
+ * {}
751
+ */
752
+ outputs?: {
753
+ [name: string]: any;
754
+ };
755
+ error_output?: ErrorOutput;
756
+ retry_strategy?: /* different behaviors for retrying failed execution actions. */ RetryStrategy;
757
+ }
758
+ export interface AutomationActionConfig {
759
+ id?: /**
760
+ * example:
761
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
762
+ */
763
+ AutomationActionId;
764
+ flow_action_id?: /**
765
+ * example:
766
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
767
+ */
768
+ AutomationActionId;
769
+ name?: string;
770
+ type?: string;
771
+ config?: {
772
+ [name: string]: any;
773
+ };
774
+ /**
775
+ * Whether to stop execution in a failed state if this action fails
776
+ */
777
+ allow_failure?: boolean;
778
+ /**
779
+ * Flag indicating whether the action was created automatically or manually
780
+ */
781
+ created_automatically?: boolean;
782
+ /**
783
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
784
+ */
785
+ is_bulk_action?: boolean;
786
+ reason?: {
787
+ /**
788
+ * Why the action has to be skipped/failed
789
+ * example:
790
+ * There are no registered portal users for the given emails, hence skipping the action
791
+ */
792
+ message?: string;
793
+ /**
794
+ * Extra metadata about the skipping reason - such as a certain condition not met, etc.
795
+ */
796
+ payload?: {
797
+ [name: string]: any;
798
+ };
799
+ };
800
+ /**
801
+ * Condition Id to be checked before executing the action
802
+ */
803
+ condition_id?: string;
804
+ /**
805
+ * Schedule Id which indicates the schedule of the action
806
+ */
807
+ schedule_id?: string;
808
+ }
809
+ export interface AutomationActionExecutionState {
810
+ execution_status?: ExecutionStatus;
811
+ started_at?: string;
812
+ updated_at?: string;
813
+ /**
814
+ * example:
815
+ * {}
816
+ */
817
+ outputs?: {
818
+ [name: string]: any;
819
+ };
820
+ error_output?: ErrorOutput;
821
+ retry_strategy?: /* different behaviors for retrying failed execution actions. */ RetryStrategy;
822
+ }
823
+ /**
824
+ * example:
825
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
826
+ */
827
+ export type AutomationActionId = string;
828
+ export interface AutomationExecution {
829
+ id: /**
830
+ * example:
831
+ * 9baf184f-bc81-4128-bca3-d974c90a12c4
832
+ */
833
+ AutomationExecutionId;
834
+ execution_status?: ExecutionStatus;
835
+ entity_id: /**
836
+ * example:
837
+ * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
838
+ */
839
+ EntityId;
840
+ activity_id?: /**
841
+ * example:
842
+ * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
843
+ */
844
+ ActivityId;
845
+ entity_snapshot?: EntityItemSnapshot;
846
+ org_id: /**
847
+ * example:
848
+ * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
849
+ */
850
+ OrganizationId;
851
+ flow_id: /**
852
+ * ID of the Automation Flow
853
+ * example:
854
+ * 7791b04a-16d2-44a2-9af9-2d59c25c512f
855
+ */
856
+ AutomationFlowId;
857
+ /**
858
+ * example:
859
+ * Handle contact form
860
+ */
861
+ flow_name?: string;
862
+ created_at?: string; // date-time
863
+ updated_at?: string; // date-time
864
+ current_action_id?: /**
865
+ * example:
866
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
867
+ */
868
+ AutomationActionId;
869
+ conditions?: ActionCondition[];
870
+ schedules?: ActionSchedule[];
871
+ actions: AnyAction[];
872
+ resume_token?: /**
873
+ * A unique token to resume a paused automation execution
874
+ * example:
875
+ * eyJraWQiOiJrZXkifQ==
876
+ */
877
+ ResumeToken;
878
+ trigger_context?: /**
879
+ * 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.
880
+ * example:
881
+ * {
882
+ * "entity_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
883
+ * }
884
+ */
885
+ TriggerContext;
886
+ /**
887
+ * Version of the flow
888
+ * example:
889
+ * 2
890
+ */
891
+ version?: number;
892
+ trigger_event?: TriggerEventManual | TriggerEventEntityActivity | TriggerEventEntityOperation | TriggerEventFlowAutomationTask | TriggerEventMessaging;
893
+ workflow_context?: WorkflowExecutionContext;
894
+ }
895
+ /**
896
+ * example:
897
+ * 9baf184f-bc81-4128-bca3-d974c90a12c4
898
+ */
899
+ export type AutomationExecutionId = string;
900
+ export interface AutomationFlow {
901
+ id?: /**
902
+ * ID of the Automation Flow
903
+ * example:
904
+ * 7791b04a-16d2-44a2-9af9-2d59c25c512f
905
+ */
906
+ AutomationFlowId;
907
+ /**
908
+ * A descriptive name for the Automation
909
+ * example:
910
+ * Handle contact form
911
+ */
912
+ flow_name: string;
913
+ /**
914
+ * Whether the automation is enabled or not
915
+ */
916
+ enabled?: boolean;
917
+ disable_details?: {
918
+ /**
919
+ * When the flow was disabled
920
+ */
921
+ disabled_at: string; // date-time
922
+ /**
923
+ * Who disabled the flow (system or user)
924
+ */
925
+ disabled_by: "system" | "user";
926
+ /**
927
+ * The 360 user email that disabled the flow
928
+ */
929
+ blame?: string;
930
+ };
931
+ triggers: AnyTrigger[];
932
+ trigger_conditions?: /**
933
+ * example:
934
+ * {
935
+ * "source": "billing_contact.email",
936
+ * "comparison": "exists"
937
+ * }
938
+ */
939
+ TriggerCondition[];
940
+ /**
941
+ * The triggering entity schema
942
+ * example:
943
+ * submission
944
+ */
945
+ entity_schema?: string;
946
+ conditions?: ActionCondition[];
947
+ schedules?: ActionSchedule[];
948
+ /**
949
+ * The actions (nodes) of the automation flow
950
+ */
951
+ actions: AnyAction[];
952
+ /**
953
+ * Number of automation executions that ran
954
+ * example:
955
+ * 7
956
+ */
957
+ runs?: number;
958
+ /**
959
+ * Customized execution hot flow rate limit. Takes precedence over the default hot flow rate limit if specified.
960
+ */
961
+ max_executions?: {
962
+ /**
963
+ * Maximum number of executions per time window
964
+ * example:
965
+ * 100
966
+ */
967
+ count?: number;
968
+ /**
969
+ * ISO 8601 duration time window for the threshold
970
+ * example:
971
+ * PT1M
972
+ */
973
+ window?: string;
974
+ };
975
+ created_at?: string; // date-time
976
+ updated_at?: string; // date-time
977
+ /**
978
+ * User / service who created automation flow
979
+ * example:
980
+ * user:123
981
+ */
982
+ created_by?: string;
983
+ /**
984
+ * User / service who last updated automation flow
985
+ * example:
986
+ * user:123
987
+ */
988
+ last_updated_by?: string;
989
+ /**
990
+ * Organization the automation flow belongs to
991
+ * example:
992
+ * 123
993
+ */
994
+ org_id?: string;
995
+ /**
996
+ * Determines if the flow is a system generated flow
997
+ */
998
+ system_flow?: boolean;
999
+ /**
1000
+ * Version of the flow
1001
+ * example:
1002
+ * 2
1003
+ */
1004
+ version?: number;
1005
+ /**
1006
+ * Source blueprint/manifest ID used when automation is created via blueprints.
1007
+ */
1008
+ _manifest?: string /* uuid */[] | null;
1009
+ workflow_context?: /* For automation that are connected to workflows V2, this field tracks various information about the workflow. */ WorkflowContext;
1010
+ }
1011
+ /**
1012
+ * ID of the Automation Flow
1013
+ * example:
1014
+ * 7791b04a-16d2-44a2-9af9-2d59c25c512f
1015
+ */
1016
+ export type AutomationFlowId = string;
1017
+ export interface AutomationTrigger {
1018
+ /**
1019
+ * example:
1020
+ * 12d4f45a-1883-4841-a94c-5928cb338a94
1021
+ */
1022
+ id?: string; // uuid
1023
+ }
1024
+ export interface BulkTriggerJob {
1025
+ job_id: /**
1026
+ * Job ID for tracking the status of bulk trigger automation executions
1027
+ * example:
1028
+ * 8c086140-f33e-4bb7-a993-50c0f2402c7b
1029
+ */
1030
+ JobId;
1031
+ org_id: /**
1032
+ * example:
1033
+ * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
1034
+ */
1035
+ OrganizationId;
1036
+ flow_id: /**
1037
+ * ID of the Automation Flow
1038
+ * example:
1039
+ * 7791b04a-16d2-44a2-9af9-2d59c25c512f
1040
+ */
1041
+ AutomationFlowId;
1042
+ /**
1043
+ * Status of the bulk trigger automation job
1044
+ * * approval: Waiting for user approval to start the bulk trigger automation
1045
+ * * querying_entities: Loading entities in batches
1046
+ * * entities_loaded: All entities have been loaded and stored
1047
+ * * executing: Automation execution are currently running
1048
+ * * monitoring: All executions have been started, now monitoring their completion
1049
+ * * send_report: Automation executions finished running. Report is being created & sent to the user who initiated the bulk trigger automation
1050
+ * * finished: Automation executions finished running. Some may have failed. Check the status of each entity.
1051
+ * * failed: Bulk trigger automation execution failed. Some executions might have started. Check the status of each entity.
1052
+ * * cancelled: Bulk trigger automation execution was cancelled
1053
+ *
1054
+ */
1055
+ status: "approval" | "querying_entities" | "entities_loaded" | "executing" | "monitoring" | "send_report" | "finished" | "failed" | "cancelled";
1056
+ /**
1057
+ * User ID who created the bulk trigger automation job
1058
+ * example:
1059
+ * 1234
1060
+ */
1061
+ created_by: string;
1062
+ created_at: string; // date-time
1063
+ updated_at: string; // date-time
1064
+ /**
1065
+ * Time when the bulk trigger automation executions job was approved
1066
+ */
1067
+ approved_at?: string; // date-time
1068
+ trigger_context?: /**
1069
+ * 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.
1070
+ * example:
1071
+ * {
1072
+ * "entity_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
1073
+ * }
1074
+ */
1075
+ TriggerContext;
1076
+ /**
1077
+ * Task token to approve/cancel the bulk automation job
1078
+ * example:
1079
+ * 8c086140-f33e-4bb7-a993-50c0f2402c7b
1080
+ */
1081
+ task_token?: string;
1082
+ /**
1083
+ * Entity ID of the report file entity
1084
+ */
1085
+ report_file_entity_id?: string;
1086
+ /**
1087
+ * Query configuration for loading entities
1088
+ */
1089
+ entity_query?: {
1090
+ type: "refs" | "query" | "filter";
1091
+ data: EntityRef[] | string | /**
1092
+ * 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.
1093
+ * example:
1094
+ * [
1095
+ * {
1096
+ * "term": {
1097
+ * "_schema": "contact"
1098
+ * }
1099
+ * },
1100
+ * {
1101
+ * "terms": {
1102
+ * "status": [
1103
+ * "active"
1104
+ * ]
1105
+ * }
1106
+ * }
1107
+ * ]
1108
+ */
1109
+ EntitySearchFilter;
1110
+ };
1111
+ /**
1112
+ * Pagination state for entity loading
1113
+ */
1114
+ pagination_state?: {
1115
+ /**
1116
+ * Number of entities per page
1117
+ */
1118
+ page_size?: number;
1119
+ /**
1120
+ * Number of pages processed so far
1121
+ */
1122
+ pages_processed?: number;
1123
+ /**
1124
+ * Total number of entities processed so far
1125
+ */
1126
+ total_processed?: number;
1127
+ /**
1128
+ * Stable query ID for pagination
1129
+ */
1130
+ stable_query_id?: string;
1131
+ /**
1132
+ * Last sort value used for pagination
1133
+ */
1134
+ search_after?: (string | number)[];
1135
+ /**
1136
+ * Whether there are more entities to load
1137
+ */
1138
+ has_more?: boolean;
1139
+ };
1140
+ /**
1141
+ * List of entities & their automation execution id & status
1142
+ */
1143
+ execution_summary?: /* Execution item for bulk trigger automation. It maps each entity to its automation execution id & status */ ExecItem[];
1144
+ }
1145
+ export type BulkTriggerRequest = {
1146
+ flow_id: /**
1147
+ * ID of the Automation Flow
1148
+ * example:
1149
+ * 7791b04a-16d2-44a2-9af9-2d59c25c512f
1150
+ */
1151
+ AutomationFlowId;
1152
+ entities_refs: EntityRef[];
1153
+ trigger_context?: /**
1154
+ * 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.
1155
+ * example:
1156
+ * {
1157
+ * "entity_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
1158
+ * }
1159
+ */
1160
+ TriggerContext;
1161
+ } | {
1162
+ flow_id: /**
1163
+ * ID of the Automation Flow
1164
+ * example:
1165
+ * 7791b04a-16d2-44a2-9af9-2d59c25c512f
1166
+ */
1167
+ AutomationFlowId;
1168
+ entities_query: string;
1169
+ trigger_context?: /**
1170
+ * 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.
1171
+ * example:
1172
+ * {
1173
+ * "entity_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
1174
+ * }
1175
+ */
1176
+ TriggerContext;
1177
+ } | {
1178
+ flow_id: /**
1179
+ * ID of the Automation Flow
1180
+ * example:
1181
+ * 7791b04a-16d2-44a2-9af9-2d59c25c512f
1182
+ */
1183
+ AutomationFlowId;
1184
+ entities_filter: /**
1185
+ * 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.
1186
+ * example:
1187
+ * [
1188
+ * {
1189
+ * "term": {
1190
+ * "_schema": "contact"
1191
+ * }
1192
+ * },
1193
+ * {
1194
+ * "terms": {
1195
+ * "status": [
1196
+ * "active"
1197
+ * ]
1198
+ * }
1199
+ * }
1200
+ * ]
1201
+ */
1202
+ EntitySearchFilter;
1203
+ trigger_context?: /**
1204
+ * 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.
1205
+ * example:
1206
+ * {
1207
+ * "entity_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
1208
+ * }
1209
+ */
1210
+ TriggerContext;
1211
+ };
1212
+ /**
1213
+ * A reason for cancelling a flow execution
1214
+ */
1215
+ export interface CancellationReason {
1216
+ /**
1217
+ * Unique identifier for the cancellation reason
1218
+ * example:
1219
+ * _6kITMwkv_0Uo4i7fO7Ja
1220
+ */
1221
+ id: string;
1222
+ /**
1223
+ * Human-readable title for the cancellation reason
1224
+ * example:
1225
+ * Process completed successfully
1226
+ */
1227
+ title: string;
1228
+ }
1229
+ /**
1230
+ * Creates an order entity with prices from journey
1231
+ */
1232
+ export interface CartCheckoutAction {
1233
+ id?: /**
1234
+ * example:
1235
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
1236
+ */
1237
+ AutomationActionId;
1238
+ flow_action_id?: /**
1239
+ * example:
1240
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
1241
+ */
1242
+ AutomationActionId;
1243
+ name?: string;
1244
+ type?: "cart-checkout";
1245
+ config?: CartCheckoutConfig;
1246
+ /**
1247
+ * Whether to stop execution in a failed state if this action fails
1248
+ */
1249
+ allow_failure?: boolean;
1250
+ /**
1251
+ * Flag indicating whether the action was created automatically or manually
1252
+ */
1253
+ created_automatically?: boolean;
1254
+ /**
1255
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
1256
+ */
1257
+ is_bulk_action?: boolean;
1258
+ reason?: {
1259
+ /**
1260
+ * Why the action has to be skipped/failed
1261
+ * example:
1262
+ * There are no registered portal users for the given emails, hence skipping the action
1263
+ */
1264
+ message?: string;
1265
+ /**
1266
+ * Extra metadata about the skipping reason - such as a certain condition not met, etc.
1267
+ */
1268
+ payload?: {
1269
+ [name: string]: any;
1270
+ };
1271
+ };
1272
+ /**
1273
+ * Condition Id to be checked before executing the action
1274
+ */
1275
+ condition_id?: string;
1276
+ /**
1277
+ * Schedule Id which indicates the schedule of the action
1278
+ */
1279
+ schedule_id?: string;
1280
+ execution_status?: ExecutionStatus;
1281
+ started_at?: string;
1282
+ updated_at?: string;
1283
+ /**
1284
+ * example:
1285
+ * {}
1286
+ */
1287
+ outputs?: {
1288
+ [name: string]: any;
1289
+ };
1290
+ error_output?: ErrorOutput;
1291
+ retry_strategy?: /* different behaviors for retrying failed execution actions. */ RetryStrategy;
1292
+ }
1293
+ /**
1294
+ * Creates an order entity with prices from journey
1295
+ */
1296
+ export interface CartCheckoutActionConfig {
1297
+ id?: /**
1298
+ * example:
1299
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
1300
+ */
1301
+ AutomationActionId;
1302
+ flow_action_id?: /**
1303
+ * example:
1304
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
1305
+ */
1306
+ AutomationActionId;
1307
+ name?: string;
1308
+ type?: "cart-checkout";
1309
+ config?: CartCheckoutConfig;
1310
+ /**
1311
+ * Whether to stop execution in a failed state if this action fails
1312
+ */
1313
+ allow_failure?: boolean;
1314
+ /**
1315
+ * Flag indicating whether the action was created automatically or manually
1316
+ */
1317
+ created_automatically?: boolean;
1318
+ /**
1319
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
1320
+ */
1321
+ is_bulk_action?: boolean;
1322
+ reason?: {
1323
+ /**
1324
+ * Why the action has to be skipped/failed
1325
+ * example:
1326
+ * There are no registered portal users for the given emails, hence skipping the action
1327
+ */
1328
+ message?: string;
1329
+ /**
1330
+ * Extra metadata about the skipping reason - such as a certain condition not met, etc.
1331
+ */
1332
+ payload?: {
1333
+ [name: string]: any;
1334
+ };
1335
+ };
1336
+ /**
1337
+ * Condition Id to be checked before executing the action
1338
+ */
1339
+ condition_id?: string;
1340
+ /**
1341
+ * Schedule Id which indicates the schedule of the action
1342
+ */
1343
+ schedule_id?: string;
1344
+ }
1345
+ export interface CartCheckoutConfig {
1346
+ /**
1347
+ * Version of the config
1348
+ */
1349
+ version?: string;
1350
+ mapping_config?: MappingConfigRef;
1351
+ relation_attributes?: RelationAttribute[];
1352
+ mapping_attributes?: (/**
1353
+ * example:
1354
+ * {
1355
+ * "target": "_tags",
1356
+ * "operation": {
1357
+ * "_append": [
1358
+ * "new",
1359
+ * "tags"
1360
+ * ],
1361
+ * "_uniq": true
1362
+ * }
1363
+ * }
1364
+ */
1365
+ MappingAttributeV2 | MappingAttribute)[];
1366
+ /**
1367
+ * Relation attribute on the main entity where the target entity will be linked. Set to false to disable linkback
1368
+ *
1369
+ */
1370
+ linkback_relation_attribute?: string;
1371
+ /**
1372
+ * Relation tags (labels) to include in main entity linkback relation attribute
1373
+ */
1374
+ linkback_relation_tags?: string[];
1375
+ /**
1376
+ * Unique key for target entity (see upsertEntity of Entity API)
1377
+ */
1378
+ target_unique?: string[];
1379
+ }
1380
+ export type Comparison = "equals" | "any_of" | "not_empty" | "is_empty";
1381
+ /**
1382
+ * example:
1383
+ * {
1384
+ * "source": {
1385
+ * "origin": "trigger",
1386
+ * "originType": "entity",
1387
+ * "id": "trigger-id",
1388
+ * "schema": "contact",
1389
+ * "attribute": "email",
1390
+ * "attributeType": "text"
1391
+ * },
1392
+ * "operation": "equals",
1393
+ * "values": [
1394
+ * "hello@epilot.cloud"
1395
+ * ]
1396
+ * }
1397
+ */
1398
+ export interface ConditionStatement {
1399
+ /**
1400
+ * example:
1401
+ * 1c8d3d9c-6d4c-4a83-aa22-aa0d630cbc2d
1402
+ */
1403
+ id?: string; // uuid
1404
+ source?: {
1405
+ /**
1406
+ * The id of the action or trigger
1407
+ */
1408
+ id?: string;
1409
+ origin?: "trigger" | "action";
1410
+ originType?: "entity" | "workflow" | "journey_block";
1411
+ schema?: string;
1412
+ attribute?: string;
1413
+ 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";
1414
+ attributeRepeatable?: boolean;
1415
+ /**
1416
+ * Whether to apply the operation to each item of the repeatable attribute
1417
+ */
1418
+ repeatableItemOp?: boolean;
1419
+ attributeOperation?: "all" | "updated" | "added" | "deleted";
1420
+ };
1421
+ 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";
1422
+ values?: string[];
1423
+ }
1424
+ export interface CopyValueMapper {
1425
+ mode: /**
1426
+ * - 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 together with value property.
1427
+ *
1428
+ */
1429
+ MappingAttributeMode;
1430
+ /**
1431
+ * JSON like target path for the attribute. Eg. last_name
1432
+ */
1433
+ target: string;
1434
+ /**
1435
+ * JSON source path for the value to be extracted from the main entity. Eg: steps[1].['Product Info'].price
1436
+ *
1437
+ */
1438
+ source: string;
1439
+ }
1440
+ export interface CreateDocumentAction {
1441
+ id?: /**
1442
+ * example:
1443
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
1444
+ */
1445
+ AutomationActionId;
1446
+ flow_action_id?: /**
1447
+ * example:
1448
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
1449
+ */
1450
+ AutomationActionId;
1451
+ name?: string;
1452
+ type?: "create-document";
1453
+ config?: CreateDocumentConfig;
1454
+ /**
1455
+ * Whether to stop execution in a failed state if this action fails
1456
+ */
1457
+ allow_failure?: boolean;
1458
+ /**
1459
+ * Flag indicating whether the action was created automatically or manually
1460
+ */
1461
+ created_automatically?: boolean;
1462
+ /**
1463
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
1464
+ */
1465
+ is_bulk_action?: boolean;
1466
+ reason?: {
1467
+ /**
1468
+ * Why the action has to be skipped/failed
1469
+ * example:
1470
+ * There are no registered portal users for the given emails, hence skipping the action
1471
+ */
1472
+ message?: string;
1473
+ /**
1474
+ * Extra metadata about the skipping reason - such as a certain condition not met, etc.
1475
+ */
1476
+ payload?: {
1477
+ [name: string]: any;
1478
+ };
1479
+ };
1480
+ /**
1481
+ * Condition Id to be checked before executing the action
1482
+ */
1483
+ condition_id?: string;
1484
+ /**
1485
+ * Schedule Id which indicates the schedule of the action
1486
+ */
1487
+ schedule_id?: string;
1488
+ execution_status?: ExecutionStatus;
1489
+ started_at?: string;
1490
+ updated_at?: string;
1491
+ /**
1492
+ * example:
1493
+ * {}
1494
+ */
1495
+ outputs?: {
1496
+ [name: string]: any;
1497
+ };
1498
+ error_output?: ErrorOutput;
1499
+ retry_strategy?: /* different behaviors for retrying failed execution actions. */ RetryStrategy;
1500
+ }
1501
+ /**
1502
+ * example:
1503
+ * {
1504
+ * "id": "08g988-ojt2jtaga-292h-8978gsaga",
1505
+ * "name": "Create Document",
1506
+ * "type": "create-document",
1507
+ * "config": {
1508
+ * "template_id": {
1509
+ * "type": "string",
1510
+ * "example": "112b08ba-789c-42f2-9940-43b302f641e8\""
1511
+ * },
1512
+ * "filename": {
1513
+ * "type": "string",
1514
+ * "example": "newsletter.pdf\""
1515
+ * }
1516
+ * }
1517
+ * }
1518
+ */
1519
+ export interface CreateDocumentActionConfig {
1520
+ id?: /**
1521
+ * example:
1522
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
1523
+ */
1524
+ AutomationActionId;
1525
+ flow_action_id?: /**
1526
+ * example:
1527
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
1528
+ */
1529
+ AutomationActionId;
1530
+ name?: string;
1531
+ type?: "create-document";
1532
+ config?: CreateDocumentConfig;
1533
+ /**
1534
+ * Whether to stop execution in a failed state if this action fails
1535
+ */
1536
+ allow_failure?: boolean;
1537
+ /**
1538
+ * Flag indicating whether the action was created automatically or manually
1539
+ */
1540
+ created_automatically?: boolean;
1541
+ /**
1542
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
1543
+ */
1544
+ is_bulk_action?: boolean;
1545
+ reason?: {
1546
+ /**
1547
+ * Why the action has to be skipped/failed
1548
+ * example:
1549
+ * There are no registered portal users for the given emails, hence skipping the action
1550
+ */
1551
+ message?: string;
1552
+ /**
1553
+ * Extra metadata about the skipping reason - such as a certain condition not met, etc.
1554
+ */
1555
+ payload?: {
1556
+ [name: string]: any;
1557
+ };
1558
+ };
1559
+ /**
1560
+ * Condition Id to be checked before executing the action
1561
+ */
1562
+ condition_id?: string;
1563
+ /**
1564
+ * Schedule Id which indicates the schedule of the action
1565
+ */
1566
+ schedule_id?: string;
1567
+ }
1568
+ export interface CreateDocumentConfig {
1569
+ template_id?: string;
1570
+ filename?: string;
1571
+ }
1572
+ export interface CustomAction {
1573
+ id?: /**
1574
+ * example:
1575
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
1576
+ */
1577
+ AutomationActionId;
1578
+ flow_action_id?: /**
1579
+ * example:
1580
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
1581
+ */
1582
+ AutomationActionId;
1583
+ name?: string;
1584
+ type?: "custom-action";
1585
+ config?: {
1586
+ [name: string]: any;
1587
+ /**
1588
+ * The name of the custom action
1589
+ * example:
1590
+ * Credit Check
1591
+ */
1592
+ name?: string;
1593
+ /**
1594
+ * The description of the custom action
1595
+ * example:
1596
+ * Check if the customer has a credit limit
1597
+ */
1598
+ description?: string;
1599
+ /**
1600
+ * The ID of the app to fetch configuration from the app API
1601
+ * example:
1602
+ * c451c26a-cc7a-4c1c-92bf-1c6246cbfe88
1603
+ */
1604
+ app_id?: string;
1605
+ /**
1606
+ * The ID of the component from the app. As the app can potentially have multiple custom actions, this ID is used to identify the component
1607
+ * example:
1608
+ * 2f1c26a-cc7a-4c1c-92bf-1c6246cbfe88
1609
+ */
1610
+ component_id?: string;
1611
+ /**
1612
+ * Whether to wait for the callback from the custom action
1613
+ */
1614
+ wait_for_callback?: boolean;
1615
+ };
1616
+ /**
1617
+ * Whether to stop execution in a failed state if this action fails
1618
+ */
1619
+ allow_failure?: boolean;
1620
+ /**
1621
+ * Flag indicating whether the action was created automatically or manually
1622
+ */
1623
+ created_automatically?: boolean;
1624
+ /**
1625
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
1626
+ */
1627
+ is_bulk_action?: boolean;
1628
+ reason?: {
1629
+ /**
1630
+ * Why the action has to be skipped/failed
1631
+ * example:
1632
+ * There are no registered portal users for the given emails, hence skipping the action
1633
+ */
1634
+ message?: string;
1635
+ /**
1636
+ * Extra metadata about the skipping reason - such as a certain condition not met, etc.
1637
+ */
1638
+ payload?: {
1639
+ [name: string]: any;
1640
+ };
1641
+ };
1642
+ /**
1643
+ * Condition Id to be checked before executing the action
1644
+ */
1645
+ condition_id?: string;
1646
+ /**
1647
+ * Schedule Id which indicates the schedule of the action
1648
+ */
1649
+ schedule_id?: string;
1650
+ execution_status?: ExecutionStatus;
1651
+ started_at?: string;
1652
+ updated_at?: string;
1653
+ /**
1654
+ * example:
1655
+ * {}
1656
+ */
1657
+ outputs?: {
1658
+ [name: string]: any;
1659
+ };
1660
+ error_output?: ErrorOutput;
1661
+ retry_strategy?: /* different behaviors for retrying failed execution actions. */ RetryStrategy;
1662
+ }
1663
+ export type DiffAdded = FilterConditionOnEvent;
1664
+ export type DiffDeleted = FilterConditionOnEvent;
1665
+ export type DiffUpdated = FilterConditionOnEvent;
1666
+ /**
1667
+ * example:
1668
+ * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
1669
+ */
1670
+ export type EntityId = string;
1671
+ export interface EntityItemSnapshot {
1672
+ [name: string]: any;
1673
+ _id: /**
1674
+ * example:
1675
+ * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
1676
+ */
1677
+ EntityId;
1678
+ _title: string;
1679
+ _org: string;
1680
+ _schema: string;
1681
+ _tags?: string[];
1682
+ _created_at: string; // date-time
1683
+ _updated_at: string; // date-time
1684
+ }
1685
+ export interface EntityManualTrigger {
1686
+ /**
1687
+ * example:
1688
+ * 12d4f45a-1883-4841-a94c-5928cb338a94
1689
+ */
1690
+ id?: string; // uuid
1691
+ type: "entity_manual";
1692
+ configuration: {
1693
+ /**
1694
+ * Which entity type can this automation be triggered from
1695
+ * example:
1696
+ * submission
1697
+ */
1698
+ schema?: string;
1699
+ };
1700
+ }
1701
+ export type EntityOperation = "createEntity" | "updateEntity" | "deleteEntity" | "softDeleteEntity" | "restoreEntity";
1702
+ /**
1703
+ * - If provides filter_config, executes an automation based on the filtered configuration when an entity event occurs.
1704
+ * - The conditions on a filter follows the event bridge patterns - `https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html`
1705
+ * | Comparison | Example | Rule syntax |
1706
+ * |------------------------|-----------------------------------------------------|----------------------------------------------------------|
1707
+ * | Null | first_name is null | `"first_name": [ null ]` |
1708
+ * | Empty | last_name is empty | `"last_name": [""]` |
1709
+ * | Equals | email is "j.doe@email.com" | `"email": [ "j.doe@email.com" ]` |
1710
+ * | Equals (ignore case) | first_name is "John" | `"first_name": [ { "equals-ignore-case": "john" } ]` |
1711
+ * | And | fist_name is "John" and last_name is "Doe" | `"first_name": [ "John" ], "last_name": ["Doe"]` |
1712
+ * | Or | PaymentType is "Invoice" or "SEPA" | `"PaymentType": [ "invoice", "sepa"]` |
1713
+ * | Or (multiple fields) | first_name is "John", or last_name is "Doe". | `"$or": [ { "first_name": [ "John" ] }, { "last_name": [ "Doe" ] } ]` |
1714
+ * | Not | status is anything but "cancelled" | `"status": [ { "anything-but": [ "cancelled" ] } ]` |
1715
+ * | Numeric (equals) | Price is 100 | `"Price": [ { "numeric": [ "=", 100 ] } ]` |
1716
+ * | Numeric (range) | Price is more than 10, and less than or equal to 20 | `"Price": [ { "numeric": [ ">", 10, "<=", 20 ] } ]` |
1717
+ * | Exists | ProductName exists | `"ProductName": [ { "exists": true } ]` |
1718
+ * | Does not exist | ProductName does not exist | `"ProductName": [ { "exists": false } ]` |
1719
+ * | Begins with | OpportunityNumber starts with OPP- | `"opportunity_number": [ { "prefix": "OPP-" } ]` |
1720
+ * | Ends with | FileName ends with a .png extension | `"filename": [ { "suffix": ".png" } ]` |
1721
+ * | Wildcard | search a string using a wildcard | `"email": [ { "wildcard": "*@doe.com" } ]` |
1722
+ * - To run the execution on all update events
1723
+ * ```
1724
+ * {
1725
+ * "type": "filter_entity_event",
1726
+ * "configuration": {
1727
+ * "operation": {
1728
+ * "operation": ["updateEntity"]
1729
+ * }
1730
+ * }
1731
+ * }
1732
+ * ```
1733
+ * - To run the execution only when the updates are from a portal user
1734
+ * ```
1735
+ * {
1736
+ * "type": "filter_entity_event",
1737
+ * "configuration": {
1738
+ * "operation": {
1739
+ * "operation": ["updateEntity"]
1740
+ * },
1741
+ * "activity": {
1742
+ * "type": "EntityUpdatedFromPortal"
1743
+ * }
1744
+ * }
1745
+ * }
1746
+ * ```
1747
+ * - To run the execution only when there is an update on a specific attribute
1748
+ * ```
1749
+ * Only starts the automation when the email on a contact is changed
1750
+ * {
1751
+ * "type": "filter_entity_event",
1752
+ * "configuration": {
1753
+ * "operation": {
1754
+ * "operation": ["updateEntity"],
1755
+ * "payload": {
1756
+ * "_schema": ["contact"]
1757
+ * },
1758
+ * "diff": {
1759
+ * "updated": {
1760
+ * "email": [{ "exists": true }]
1761
+ * }
1762
+ * }
1763
+ * }
1764
+ * }
1765
+ * }
1766
+ * ```
1767
+ * - To run the execution only when a specific attribute is altered(created/updated/deleted)
1768
+ * ```
1769
+ * Only starts the automation when a price is altered on a contract
1770
+ * {
1771
+ * "type": "filter_entity_event",
1772
+ * "configuration": {
1773
+ * "operation": {
1774
+ * "payload": {
1775
+ * "_schema": ["contract"]
1776
+ * },
1777
+ * "diff": {
1778
+ * // Whether he first_name has been added, updated, or removed
1779
+ * $or: [
1780
+ * {
1781
+ * 'added.first_name': [{ exists: true }]
1782
+ * },
1783
+ * {
1784
+ * 'updated.first_name': [{ exists: true }]
1785
+ * },
1786
+ * {
1787
+ * 'deleted.first_name': [{ exists: true }]
1788
+ * }
1789
+ * ]
1790
+ * }
1791
+ * }
1792
+ * }
1793
+ * }
1794
+ * ```
1795
+ * - To run the execution if an attribute is changed from one state to another
1796
+ * ```
1797
+ * Only starts the automation when the order status changes from `open_for_acceptance` to `placed`
1798
+ * {
1799
+ * "type": "filter_entity_event",
1800
+ * "configuration": {
1801
+ * "operation": {
1802
+ * "operation": ["updateEntity"],
1803
+ * "payload": {
1804
+ * "_schema": ["order"],
1805
+ * "status": ["placed"]
1806
+ * },
1807
+ * "diff": {
1808
+ * "updated": {
1809
+ * "status": ["open_for_acceptance"]
1810
+ * }
1811
+ * }
1812
+ * }
1813
+ * }
1814
+ * }
1815
+ * ```
1816
+ *
1817
+ */
1818
+ export interface EntityOperationTrigger {
1819
+ /**
1820
+ * example:
1821
+ * 12d4f45a-1883-4841-a94c-5928cb338a94
1822
+ */
1823
+ id?: string; // uuid
1824
+ type: "entity_operation";
1825
+ configuration: {
1826
+ /**
1827
+ * example:
1828
+ * submission
1829
+ */
1830
+ schema?: string;
1831
+ operations?: [
1832
+ EntityOperation,
1833
+ ...EntityOperation[]
1834
+ ];
1835
+ include_activities?: string[];
1836
+ exclude_activities?: string[];
1837
+ filter_config?: {
1838
+ operation?: {
1839
+ /**
1840
+ * Filter on operation type. If not specified, all operations will be matched on execution.
1841
+ * Example:
1842
+ * 1. Filter all the createEntity/updateEntity operations
1843
+ * ```
1844
+ * {
1845
+ * "operation":{
1846
+ * "operation": ["createEntity", "updateEntity"]
1847
+ * }
1848
+ * }
1849
+ * ```
1850
+ *
1851
+ */
1852
+ operation?: EntityOperation[];
1853
+ payload?: FilterConditionOnEvent;
1854
+ diff?: OrConditionForDiff | {
1855
+ added?: DiffAdded;
1856
+ updated?: DiffUpdated;
1857
+ deleted?: DiffDeleted;
1858
+ };
1859
+ };
1860
+ activity?: {
1861
+ /**
1862
+ * Filter on activity type. If not specified, all activities will be matched on execution.
1863
+ * Example:
1864
+ * 1. Filter the events when an entity is updated from portal
1865
+ * ```
1866
+ * {
1867
+ * "activity":{
1868
+ * "type": ["EntityUpdatedFromPortal"]
1869
+ * }
1870
+ * }
1871
+ * ```
1872
+ * 2. Filter the events when either a doc is uploaded/removed on an entity from a portal
1873
+ * ```
1874
+ * {
1875
+ * "activity":{
1876
+ * "type": ["DocUploadedFromPortal", "DocRemovedFromPortal"]
1877
+ * }
1878
+ * }
1879
+ * ```
1880
+ *
1881
+ * example:
1882
+ * [
1883
+ * "EntityUpdatedFromPortal",
1884
+ * "EntityUpdated",
1885
+ * "DocUploadedFromPortal"
1886
+ * ]
1887
+ */
1888
+ type?: (string | EqualsIgnoreCaseCondition | AnythingButCondition | ExistsCondition | PrefixCondition | SuffixCondition | WildcardCondition)[];
1889
+ };
1890
+ };
1891
+ ecp_config?: {
1892
+ /**
1893
+ * example:
1894
+ * END_CUSTOMER_PORTAL
1895
+ */
1896
+ origin?: string;
1897
+ /**
1898
+ * example:
1899
+ * any-portal-id
1900
+ */
1901
+ portal_id?: string;
1902
+ file_config?: {
1903
+ /**
1904
+ * example:
1905
+ * true
1906
+ */
1907
+ shared_with_end_customer?: boolean;
1908
+ };
1909
+ };
1910
+ };
1911
+ }
1912
+ export interface EntityRef {
1913
+ entity_id: /**
1914
+ * example:
1915
+ * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
1916
+ */
1917
+ EntityId;
1918
+ entity_schema: string;
1919
+ }
1920
+ /**
1921
+ * 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.
1922
+ * example:
1923
+ * [
1924
+ * {
1925
+ * "term": {
1926
+ * "_schema": "contact"
1927
+ * }
1928
+ * },
1929
+ * {
1930
+ * "terms": {
1931
+ * "status": [
1932
+ * "active"
1933
+ * ]
1934
+ * }
1935
+ * }
1936
+ * ]
1937
+ */
1938
+ export type EntitySearchFilter = {
1939
+ /**
1940
+ * Returns documents that contain an exact term in a provided field.
1941
+ *
1942
+ * To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.
1943
+ *
1944
+ * You likely DO NOT want to use this filter on text fields and want to target its .keyword instead.
1945
+ *
1946
+ * example:
1947
+ * {
1948
+ * "_schema": "contact"
1949
+ * }
1950
+ */
1951
+ term?: {
1952
+ [name: string]: /* A filter field value. */ EntitySearchFilterValue;
1953
+ };
1954
+ /**
1955
+ * Returns documents that contain one of the exact terms in a provided field. See term filter for more info.
1956
+ * example:
1957
+ * {
1958
+ * "status": [
1959
+ * "active"
1960
+ * ]
1961
+ * }
1962
+ */
1963
+ terms?: {
1964
+ [name: string]: /* A filter field value. */ EntitySearchFilterValue[];
1965
+ };
1966
+ /**
1967
+ * Returns documents based on their IDs.
1968
+ * example:
1969
+ * {
1970
+ * "values": [
1971
+ * "550e8400-e29b-41d4-a716-446655440000"
1972
+ * ]
1973
+ * }
1974
+ */
1975
+ ids?: {
1976
+ values?: string[];
1977
+ };
1978
+ /**
1979
+ * Returns documents with fields that have terms within a certain range.
1980
+ * example:
1981
+ * {
1982
+ * "_created_at": {
1983
+ * "gte": "2021-01-01T00:00:00.000Z",
1984
+ * "lte": "2021-01-31T23:59:59.999Z"
1985
+ * }
1986
+ * }
1987
+ */
1988
+ range?: {
1989
+ [name: string]: {
1990
+ gt?: /* A filter field value. */ EntitySearchFilterValue;
1991
+ gte?: /* A filter field value. */ EntitySearchFilterValue;
1992
+ lt?: /* A filter field value. */ EntitySearchFilterValue;
1993
+ lte?: /* A filter field value. */ EntitySearchFilterValue;
1994
+ /**
1995
+ * The date format used to parse date values.
1996
+ */
1997
+ format?: string;
1998
+ /**
1999
+ * Indicates how the range query matches values for range fields.
2000
+ */
2001
+ relation?: "INTERSECTS" | "CONTAINS" | "WITHIN";
2002
+ /**
2003
+ * Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query to UTC.
2004
+ */
2005
+ time_zone?: string;
2006
+ };
2007
+ };
2008
+ /**
2009
+ * Returns documents that have a value in the specified field.
2010
+ * example:
2011
+ * {
2012
+ * "field": "_tags"
2013
+ * }
2014
+ */
2015
+ exists?: {
2016
+ field: string;
2017
+ };
2018
+ $and?: /**
2019
+ * 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.
2020
+ * example:
2021
+ * [
2022
+ * {
2023
+ * "term": {
2024
+ * "_schema": "contact"
2025
+ * }
2026
+ * },
2027
+ * {
2028
+ * "terms": {
2029
+ * "status": [
2030
+ * "active"
2031
+ * ]
2032
+ * }
2033
+ * }
2034
+ * ]
2035
+ */
2036
+ EntitySearchFilter;
2037
+ $or?: /**
2038
+ * 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.
2039
+ * example:
2040
+ * [
2041
+ * {
2042
+ * "term": {
2043
+ * "_schema": "contact"
2044
+ * }
2045
+ * },
2046
+ * {
2047
+ * "terms": {
2048
+ * "status": [
2049
+ * "active"
2050
+ * ]
2051
+ * }
2052
+ * }
2053
+ * ]
2054
+ */
2055
+ EntitySearchFilter;
2056
+ $not?: /**
2057
+ * 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.
2058
+ * example:
2059
+ * [
2060
+ * {
2061
+ * "term": {
2062
+ * "_schema": "contact"
2063
+ * }
2064
+ * },
2065
+ * {
2066
+ * "terms": {
2067
+ * "status": [
2068
+ * "active"
2069
+ * ]
2070
+ * }
2071
+ * }
2072
+ * ]
2073
+ */
2074
+ EntitySearchFilter;
2075
+ }[];
2076
+ /**
2077
+ * A filter field value.
2078
+ */
2079
+ export type EntitySearchFilterValue = /* A filter field value. */ (string | null) | number | boolean;
2080
+ export interface EqualsIgnoreCaseCondition {
2081
+ "equals-ignore-case"?: string;
2082
+ }
2083
+ export 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";
2084
+ export interface ErrorDetail {
2085
+ explanation: string;
2086
+ context?: string;
2087
+ id?: string;
2088
+ }
2089
+ export interface ErrorObject {
2090
+ /**
2091
+ * The HTTP status code of the error
2092
+ * example:
2093
+ * 400
2094
+ */
2095
+ status?: number;
2096
+ /**
2097
+ * The error message
2098
+ */
2099
+ error?: string;
2100
+ }
2101
+ export interface ErrorOutput {
2102
+ error_code: ErrorCode;
2103
+ error_reason: string;
2104
+ error_info?: {
2105
+ [name: string]: any;
2106
+ details?: ErrorDetail[];
2107
+ };
2108
+ }
2109
+ /**
2110
+ * Execution item for bulk trigger automation. It maps each entity to its automation execution id & status
2111
+ */
2112
+ export interface ExecItem {
2113
+ entity_id: /**
2114
+ * example:
2115
+ * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
2116
+ */
2117
+ EntityId;
2118
+ entity_schema?: string;
2119
+ execution_id?: /**
2120
+ * example:
2121
+ * 9baf184f-bc81-4128-bca3-d974c90a12c4
2122
+ */
2123
+ AutomationExecutionId;
2124
+ execution_status: ExecutionStatus;
2125
+ /**
2126
+ * Timestamp in UTC ISO format
2127
+ * example:
2128
+ * 2025-10-30T15:56:47.842Z
2129
+ */
2130
+ timestamp?: string; // date-time
2131
+ /**
2132
+ * Error message for the failed automation execution
2133
+ */
2134
+ error?: string;
2135
+ }
2136
+ /**
2137
+ * [Internal] Tracks execution chain for infinite loop prevention. This is an internal property and should not be used by external consumers.
2138
+ */
2139
+ export interface ExecutionChain {
2140
+ /**
2141
+ * ID of the parent flow execution that triggered this one
2142
+ */
2143
+ parent_execution_id?: string;
2144
+ /**
2145
+ * ID of the automation task that triggered this execution
2146
+ */
2147
+ parent_task_id?: string;
2148
+ /**
2149
+ * Current depth in the execution chain (0 = manual start)
2150
+ */
2151
+ depth?: number;
2152
+ }
2153
+ export type ExecutionStatus = "pending" | "starting" | "in_progress" | "paused" | "success" | "failed" | "cancelled" | "skipped" | "scheduled" | "hot";
2154
+ export interface ExistsCondition {
2155
+ exists?: boolean;
2156
+ }
2157
+ export type FilterConditionOnEvent = OrCondition | {
2158
+ [name: string]: (string | EqualsIgnoreCaseCondition | AnythingButCondition | NumericCondition | ExistsCondition | PrefixCondition | SuffixCondition | WildcardCondition)[];
2159
+ };
2160
+ export interface FlowExecutionCancelAction {
2161
+ id?: /**
2162
+ * example:
2163
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
2164
+ */
2165
+ AutomationActionId;
2166
+ flow_action_id?: /**
2167
+ * example:
2168
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
2169
+ */
2170
+ AutomationActionId;
2171
+ name?: string;
2172
+ type?: "cancel-flow-execution";
2173
+ config?: /* Configuration for cancelling a flow execution with selected reasons */ FlowExecutionCancelConfig;
2174
+ /**
2175
+ * Whether to stop execution in a failed state if this action fails
2176
+ */
2177
+ allow_failure?: boolean;
2178
+ /**
2179
+ * Flag indicating whether the action was created automatically or manually
2180
+ */
2181
+ created_automatically?: boolean;
2182
+ /**
2183
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
2184
+ */
2185
+ is_bulk_action?: boolean;
2186
+ reason?: {
2187
+ /**
2188
+ * Why the action has to be skipped/failed
2189
+ * example:
2190
+ * There are no registered portal users for the given emails, hence skipping the action
2191
+ */
2192
+ message?: string;
2193
+ /**
2194
+ * Extra metadata about the skipping reason - such as a certain condition not met, etc.
2195
+ */
2196
+ payload?: {
2197
+ [name: string]: any;
2198
+ };
2199
+ };
2200
+ /**
2201
+ * Condition Id to be checked before executing the action
2202
+ */
2203
+ condition_id?: string;
2204
+ /**
2205
+ * Schedule Id which indicates the schedule of the action
2206
+ */
2207
+ schedule_id?: string;
2208
+ execution_status?: ExecutionStatus;
2209
+ started_at?: string;
2210
+ updated_at?: string;
2211
+ /**
2212
+ * example:
2213
+ * {}
2214
+ */
2215
+ outputs?: {
2216
+ [name: string]: any;
2217
+ };
2218
+ error_output?: ErrorOutput;
2219
+ retry_strategy?: /* different behaviors for retrying failed execution actions. */ RetryStrategy;
2220
+ }
2221
+ /**
2222
+ * example:
2223
+ * {
2224
+ * "id": "2520gja-2sgmsaga-0asg-822jgal",
2225
+ * "name": "Cancel Flow Execution",
2226
+ * "type": "cancel-flow-execution",
2227
+ * "config": {
2228
+ * "selected_reasons": [
2229
+ * {
2230
+ * "id": "_6kITMwkv_0Uo4i7fO7Ja",
2231
+ * "title": "when you are done! that's when you close it."
2232
+ * },
2233
+ * {
2234
+ * "id": "qgK9sGbKoS7NxlAbNReVn",
2235
+ * "title": "Client didn't want our services"
2236
+ * }
2237
+ * ],
2238
+ * "extra_description": "Test cancellation"
2239
+ * }
2240
+ * }
2241
+ */
2242
+ export interface FlowExecutionCancelActionConfig {
2243
+ id?: /**
2244
+ * example:
2245
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
2246
+ */
2247
+ AutomationActionId;
2248
+ flow_action_id?: /**
2249
+ * example:
2250
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
2251
+ */
2252
+ AutomationActionId;
2253
+ name?: string;
2254
+ type?: "cancel-flow-execution";
2255
+ config?: /* Configuration for cancelling a flow execution with selected reasons */ FlowExecutionCancelConfig;
2256
+ /**
2257
+ * Whether to stop execution in a failed state if this action fails
2258
+ */
2259
+ allow_failure?: boolean;
2260
+ /**
2261
+ * Flag indicating whether the action was created automatically or manually
2262
+ */
2263
+ created_automatically?: boolean;
2264
+ /**
2265
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
2266
+ */
2267
+ is_bulk_action?: boolean;
2268
+ reason?: {
2269
+ /**
2270
+ * Why the action has to be skipped/failed
2271
+ * example:
2272
+ * There are no registered portal users for the given emails, hence skipping the action
2273
+ */
2274
+ message?: string;
2275
+ /**
2276
+ * Extra metadata about the skipping reason - such as a certain condition not met, etc.
2277
+ */
2278
+ payload?: {
2279
+ [name: string]: any;
2280
+ };
2281
+ };
2282
+ /**
2283
+ * Condition Id to be checked before executing the action
2284
+ */
2285
+ condition_id?: string;
2286
+ /**
2287
+ * Schedule Id which indicates the schedule of the action
2288
+ */
2289
+ schedule_id?: string;
2290
+ }
2291
+ /**
2292
+ * Configuration for cancelling a flow execution with selected reasons
2293
+ */
2294
+ export interface FlowExecutionCancelConfig {
2295
+ /**
2296
+ * List of reasons selected for this specific cancellation
2297
+ */
2298
+ selected_reasons?: /* A reason for cancelling a flow execution */ CancellationReason[];
2299
+ /**
2300
+ * Additional description or notes for the cancellation
2301
+ * example:
2302
+ * Process completed successfully
2303
+ */
2304
+ extra_description?: string;
2305
+ }
2306
+ export interface FlowsTrigger {
2307
+ /**
2308
+ * example:
2309
+ * 12d4f45a-1883-4841-a94c-5928cb338a94
2310
+ */
2311
+ id?: string; // uuid
2312
+ type: "flows_trigger";
2313
+ configuration: {
2314
+ /**
2315
+ * The ID of the workflow v2 that triggers this automation
2316
+ */
2317
+ source_id: string; // uuid
2318
+ /**
2319
+ * When Journeys are linked to Workflows V2 as Journey Automations, this field will contain the ID of the Journey
2320
+ */
2321
+ journey_id?: string; // uuid
2322
+ };
2323
+ }
2324
+ export interface FrontendSubmitTrigger {
2325
+ /**
2326
+ * example:
2327
+ * 12d4f45a-1883-4841-a94c-5928cb338a94
2328
+ */
2329
+ id?: string; // uuid
2330
+ type: "frontend_submission";
2331
+ configuration: {
2332
+ /**
2333
+ * example:
2334
+ * 99
2335
+ */
2336
+ source_id?: string;
2337
+ };
2338
+ }
2339
+ export interface GetExecutionsResp {
2340
+ total: number;
2341
+ results: AutomationExecution[];
2342
+ }
2343
+ export interface InformERPAction {
2344
+ id?: /**
2345
+ * example:
2346
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
2347
+ */
2348
+ AutomationActionId;
2349
+ flow_action_id?: /**
2350
+ * example:
2351
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
2352
+ */
2353
+ AutomationActionId;
2354
+ name?: string;
2355
+ type?: "inform-erp";
2356
+ config?: InformERPConfig;
2357
+ /**
2358
+ * Whether to stop execution in a failed state if this action fails
2359
+ */
2360
+ allow_failure?: boolean;
2361
+ /**
2362
+ * Flag indicating whether the action was created automatically or manually
2363
+ */
2364
+ created_automatically?: boolean;
2365
+ /**
2366
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
2367
+ */
2368
+ is_bulk_action?: boolean;
2369
+ reason?: {
2370
+ /**
2371
+ * Why the action has to be skipped/failed
2372
+ * example:
2373
+ * There are no registered portal users for the given emails, hence skipping the action
2374
+ */
2375
+ message?: string;
2376
+ /**
2377
+ * Extra metadata about the skipping reason - such as a certain condition not met, etc.
2378
+ */
2379
+ payload?: {
2380
+ [name: string]: any;
2381
+ };
2382
+ };
2383
+ /**
2384
+ * Condition Id to be checked before executing the action
2385
+ */
2386
+ condition_id?: string;
2387
+ /**
2388
+ * Schedule Id which indicates the schedule of the action
2389
+ */
2390
+ schedule_id?: string;
2391
+ execution_status?: ExecutionStatus;
2392
+ started_at?: string;
2393
+ updated_at?: string;
2394
+ /**
2395
+ * example:
2396
+ * {}
2397
+ */
2398
+ outputs?: {
2399
+ [name: string]: any;
2400
+ };
2401
+ error_output?: ErrorOutput;
2402
+ retry_strategy?: /* different behaviors for retrying failed execution actions. */ RetryStrategy;
2403
+ }
2404
+ /**
2405
+ * example:
2406
+ * {
2407
+ * "id": "2520gja-2sgmsaga-0asg-822jgal",
2408
+ * "name": "Inform ERP",
2409
+ * "type": "inform-erp",
2410
+ * "config": {
2411
+ * "entity_sources": [
2412
+ * "contact",
2413
+ * "account"
2414
+ * ],
2415
+ * "target_webhook_id": "25jg9ag2ga"
2416
+ * }
2417
+ * }
2418
+ */
2419
+ export interface InformERPActionConfig {
2420
+ id?: /**
2421
+ * example:
2422
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
2423
+ */
2424
+ AutomationActionId;
2425
+ flow_action_id?: /**
2426
+ * example:
2427
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
2428
+ */
2429
+ AutomationActionId;
2430
+ name?: string;
2431
+ type?: "inform-erp";
2432
+ config?: InformERPConfig;
2433
+ /**
2434
+ * Whether to stop execution in a failed state if this action fails
2435
+ */
2436
+ allow_failure?: boolean;
2437
+ /**
2438
+ * Flag indicating whether the action was created automatically or manually
2439
+ */
2440
+ created_automatically?: boolean;
2441
+ /**
2442
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
2443
+ */
2444
+ is_bulk_action?: boolean;
2445
+ reason?: {
2446
+ /**
2447
+ * Why the action has to be skipped/failed
2448
+ * example:
2449
+ * There are no registered portal users for the given emails, hence skipping the action
2450
+ */
2451
+ message?: string;
2452
+ /**
2453
+ * Extra metadata about the skipping reason - such as a certain condition not met, etc.
2454
+ */
2455
+ payload?: {
2456
+ [name: string]: any;
2457
+ };
2458
+ };
2459
+ /**
2460
+ * Condition Id to be checked before executing the action
2461
+ */
2462
+ condition_id?: string;
2463
+ /**
2464
+ * Schedule Id which indicates the schedule of the action
2465
+ */
2466
+ schedule_id?: string;
2467
+ }
2468
+ export interface InformERPConfig {
2469
+ entity_sources?: string[];
2470
+ target_webhook_id?: string;
2471
+ /**
2472
+ * Whether to wait for the request to finish before continuing automation execution
2473
+ */
2474
+ sync?: boolean;
2475
+ }
2476
+ /**
2477
+ * Job ID for tracking the status of bulk trigger automation executions
2478
+ * example:
2479
+ * 8c086140-f33e-4bb7-a993-50c0f2402c7b
2480
+ */
2481
+ export type JobId = string;
2482
+ export interface JourneySubmitTrigger {
2483
+ /**
2484
+ * example:
2485
+ * 12d4f45a-1883-4841-a94c-5928cb338a94
2486
+ */
2487
+ id?: string; // uuid
2488
+ type: "journey_submission";
2489
+ configuration: {
2490
+ source_id: string; // uuid
2491
+ };
2492
+ }
2493
+ export interface MapEntityAction {
2494
+ id?: /**
2495
+ * example:
2496
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
2497
+ */
2498
+ AutomationActionId;
2499
+ flow_action_id?: /**
2500
+ * example:
2501
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
2502
+ */
2503
+ AutomationActionId;
2504
+ name?: string;
2505
+ type?: "map-entity";
2506
+ config?: MapEntityConfig;
2507
+ /**
2508
+ * Whether to stop execution in a failed state if this action fails
2509
+ */
2510
+ allow_failure?: boolean;
2511
+ /**
2512
+ * Flag indicating whether the action was created automatically or manually
2513
+ */
2514
+ created_automatically?: boolean;
2515
+ /**
2516
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
2517
+ */
2518
+ is_bulk_action?: boolean;
2519
+ reason?: {
2520
+ /**
2521
+ * Why the action has to be skipped/failed
2522
+ * example:
2523
+ * There are no registered portal users for the given emails, hence skipping the action
2524
+ */
2525
+ message?: string;
2526
+ /**
2527
+ * Extra metadata about the skipping reason - such as a certain condition not met, etc.
2528
+ */
2529
+ payload?: {
2530
+ [name: string]: any;
2531
+ };
2532
+ };
2533
+ /**
2534
+ * Condition Id to be checked before executing the action
2535
+ */
2536
+ condition_id?: string;
2537
+ /**
2538
+ * Schedule Id which indicates the schedule of the action
2539
+ */
2540
+ schedule_id?: string;
2541
+ execution_status?: ExecutionStatus;
2542
+ started_at?: string;
2543
+ updated_at?: string;
2544
+ /**
2545
+ * example:
2546
+ * {}
2547
+ */
2548
+ outputs?: {
2549
+ [name: string]: any;
2550
+ };
2551
+ error_output?: ErrorOutput;
2552
+ retry_strategy?: /* different behaviors for retrying failed execution actions. */ RetryStrategy;
2553
+ }
2554
+ /**
2555
+ * example:
2556
+ * {
2557
+ * "id": "2520gja-2sgmsaga-0asg-822jgal",
2558
+ * "name": "Map Entity",
2559
+ * "type": "map-entity",
2560
+ * "config": {
2561
+ * "target_schema": "contact",
2562
+ * "target_unique": [
2563
+ * "email.0.email"
2564
+ * ],
2565
+ * "relation_attributes": [
2566
+ * {
2567
+ * "target": "company",
2568
+ * "mode": "append",
2569
+ * "source_filter": {
2570
+ * "schema": "account",
2571
+ * "limit": 1
2572
+ * }
2573
+ * }
2574
+ * ],
2575
+ * "mapping_attributes": [
2576
+ * {
2577
+ * "target": "_tags",
2578
+ * "operation": {
2579
+ * "_append": [
2580
+ * "primary",
2581
+ * "payer"
2582
+ * ],
2583
+ * "_uniq": true
2584
+ * }
2585
+ * },
2586
+ * {
2587
+ * "target": "email",
2588
+ * "operation": {
2589
+ * "_append": [
2590
+ * {
2591
+ * "email": {
2592
+ * "_copy": "billing_contact.email"
2593
+ * }
2594
+ * }
2595
+ * ]
2596
+ * }
2597
+ * },
2598
+ * {
2599
+ * "target": "first_name",
2600
+ * "operation": {
2601
+ * "_copy": "billing_contact.first_name"
2602
+ * }
2603
+ * },
2604
+ * {
2605
+ * "target": "last_name",
2606
+ * "operation": {
2607
+ * "_copy": "billing_contact.last_name"
2608
+ * }
2609
+ * },
2610
+ * {
2611
+ * "target": "contact_type",
2612
+ * "operation": {
2613
+ * "_set": "customer"
2614
+ * }
2615
+ * },
2616
+ * {
2617
+ * "target": "address",
2618
+ * "operation": {
2619
+ * "_append": [
2620
+ * {
2621
+ * "_tags": [
2622
+ * "billing",
2623
+ * "primary"
2624
+ * ],
2625
+ * "street_name": {
2626
+ * "_copy": "billing_contact.street_name"
2627
+ * },
2628
+ * "street_number": {
2629
+ * "_copy": "billing_contact.street_number"
2630
+ * },
2631
+ * "city": {
2632
+ * "_copy": "billing_contact.city"
2633
+ * },
2634
+ * "postal_code": {
2635
+ * "_copy": "billing_contact.postal_code"
2636
+ * },
2637
+ * "country": {
2638
+ * "_copy": "billing_contact.country"
2639
+ * }
2640
+ * },
2641
+ * {
2642
+ * "_tags": [
2643
+ * "delivery"
2644
+ * ],
2645
+ * "street_name": {
2646
+ * "_copy": "delivery_contact.street_name"
2647
+ * },
2648
+ * "street_number": {
2649
+ * "_copy": "delivery_contact.street_number"
2650
+ * },
2651
+ * "city": {
2652
+ * "_copy": "delivery_contact.city"
2653
+ * },
2654
+ * "postal_code": {
2655
+ * "_copy": "delivery_contact.postal_code"
2656
+ * },
2657
+ * "country": {
2658
+ * "_copy": "delivery_contact.country"
2659
+ * }
2660
+ * }
2661
+ * ],
2662
+ * "_uniq": [
2663
+ * "street_name",
2664
+ * "street_number",
2665
+ * "postal_code",
2666
+ * "country"
2667
+ * ]
2668
+ * }
2669
+ * }
2670
+ * ]
2671
+ * }
2672
+ * }
2673
+ */
2674
+ export interface MapEntityActionConfig {
2675
+ id?: /**
2676
+ * example:
2677
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
2678
+ */
2679
+ AutomationActionId;
2680
+ flow_action_id?: /**
2681
+ * example:
2682
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
2683
+ */
2684
+ AutomationActionId;
2685
+ name?: string;
2686
+ type?: "map-entity";
2687
+ config?: MapEntityConfig;
2688
+ /**
2689
+ * Whether to stop execution in a failed state if this action fails
2690
+ */
2691
+ allow_failure?: boolean;
2692
+ /**
2693
+ * Flag indicating whether the action was created automatically or manually
2694
+ */
2695
+ created_automatically?: boolean;
2696
+ /**
2697
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
2698
+ */
2699
+ is_bulk_action?: boolean;
2700
+ reason?: {
2701
+ /**
2702
+ * Why the action has to be skipped/failed
2703
+ * example:
2704
+ * There are no registered portal users for the given emails, hence skipping the action
2705
+ */
2706
+ message?: string;
2707
+ /**
2708
+ * Extra metadata about the skipping reason - such as a certain condition not met, etc.
2709
+ */
2710
+ payload?: {
2711
+ [name: string]: any;
2712
+ };
2713
+ };
2714
+ /**
2715
+ * Condition Id to be checked before executing the action
2716
+ */
2717
+ condition_id?: string;
2718
+ /**
2719
+ * Schedule Id which indicates the schedule of the action
2720
+ */
2721
+ schedule_id?: string;
2722
+ }
2723
+ export interface MapEntityConfig {
2724
+ mapping_config?: MappingConfigRef;
2725
+ /**
2726
+ * Schema of target entity
2727
+ */
2728
+ target_schema: string;
2729
+ /**
2730
+ * Unique key for target entity (see upsertEntity of Entity API)
2731
+ */
2732
+ target_unique?: string[];
2733
+ /**
2734
+ * Attribute mappings
2735
+ */
2736
+ mapping_attributes?: (/**
2737
+ * example:
2738
+ * {
2739
+ * "target": "_tags",
2740
+ * "operation": {
2741
+ * "_append": [
2742
+ * "new",
2743
+ * "tags"
2744
+ * ],
2745
+ * "_uniq": true
2746
+ * }
2747
+ * }
2748
+ */
2749
+ MappingAttributeV2 | MappingAttribute)[];
2750
+ /**
2751
+ * Relation mappings
2752
+ */
2753
+ relation_attributes?: RelationAttribute[];
2754
+ /**
2755
+ * Relation attribute on the main entity where the target entity will be linked. Set to false to disable linkback
2756
+ *
2757
+ */
2758
+ linkback_relation_attribute?: string;
2759
+ /**
2760
+ * Relation tags (labels) to include in main entity linkback relation attribute
2761
+ */
2762
+ linkback_relation_tags?: string[];
2763
+ }
2764
+ export type MappingAttribute = SetValueMapper | CopyValueMapper | AppendValueMapper;
2765
+ /**
2766
+ * - 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 together with value property.
2767
+ *
2768
+ */
2769
+ export type MappingAttributeMode = "copy_if_exists" | "append_if_exists" | "set_value";
2770
+ /**
2771
+ * example:
2772
+ * {
2773
+ * "target": "_tags",
2774
+ * "operation": {
2775
+ * "_append": [
2776
+ * "new",
2777
+ * "tags"
2778
+ * ],
2779
+ * "_uniq": true
2780
+ * }
2781
+ * }
2782
+ */
2783
+ export interface MappingAttributeV2 {
2784
+ /**
2785
+ * Target JSON path for the attribute to set
2786
+ */
2787
+ target?: string;
2788
+ operation: /* Mapping operation nodes are either primitive values or operation node objects */ OperationNode;
2789
+ }
2790
+ export interface MappingConfigRef {
2791
+ /**
2792
+ * Id of Entity Mapping Configuration to run for mapping.
2793
+ */
2794
+ config_id: string;
2795
+ /**
2796
+ * Id of TargetConfig to run for mapping.
2797
+ */
2798
+ target_id: string;
2799
+ /**
2800
+ * Version of Entity Mapping Configuration to run for mapping.
2801
+ */
2802
+ version?: number;
2803
+ }
2804
+ export interface MoveThreadAction {
2805
+ id?: /**
2806
+ * example:
2807
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
2808
+ */
2809
+ AutomationActionId;
2810
+ flow_action_id?: /**
2811
+ * example:
2812
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
2813
+ */
2814
+ AutomationActionId;
2815
+ name?: string;
2816
+ type?: "move-thread";
2817
+ config?: MoveThreadConfig;
2818
+ /**
2819
+ * Whether to stop execution in a failed state if this action fails
2820
+ */
2821
+ allow_failure?: boolean;
2822
+ /**
2823
+ * Flag indicating whether the action was created automatically or manually
2824
+ */
2825
+ created_automatically?: boolean;
2826
+ /**
2827
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
2828
+ */
2829
+ is_bulk_action?: boolean;
2830
+ reason?: {
2831
+ /**
2832
+ * Why the action has to be skipped/failed
2833
+ * example:
2834
+ * There are no registered portal users for the given emails, hence skipping the action
2835
+ */
2836
+ message?: string;
2837
+ /**
2838
+ * Extra metadata about the skipping reason - such as a certain condition not met, etc.
2839
+ */
2840
+ payload?: {
2841
+ [name: string]: any;
2842
+ };
2843
+ };
2844
+ /**
2845
+ * Condition Id to be checked before executing the action
2846
+ */
2847
+ condition_id?: string;
2848
+ /**
2849
+ * Schedule Id which indicates the schedule of the action
2850
+ */
2851
+ schedule_id?: string;
2852
+ execution_status?: ExecutionStatus;
2853
+ started_at?: string;
2854
+ updated_at?: string;
2855
+ /**
2856
+ * example:
2857
+ * {}
2858
+ */
2859
+ outputs?: {
2860
+ [name: string]: any;
2861
+ };
2862
+ error_output?: ErrorOutput;
2863
+ retry_strategy?: /* different behaviors for retrying failed execution actions. */ RetryStrategy;
2864
+ }
2865
+ export interface MoveThreadConfig {
2866
+ /**
2867
+ * ID of the inbox where the thread should be moved to
2868
+ */
2869
+ target_inbox_id?: string;
2870
+ }
2871
+ export interface NewEmailThreadTrigger {
2872
+ /**
2873
+ * example:
2874
+ * 12d4f45a-1883-4841-a94c-5928cb338a94
2875
+ */
2876
+ id?: string; // uuid
2877
+ type: "new_email_thread";
2878
+ configuration: {
2879
+ /**
2880
+ * A list of shared inbox IDs that the email thread should be matched against.
2881
+ */
2882
+ shared_inbox_ids?: string[];
2883
+ /**
2884
+ * Whether the trigger should be matched against only inbound, outbound emails or both.
2885
+ */
2886
+ direction: "INBOUND" | "OUTBOUND" | "BOTH";
2887
+ };
2888
+ }
2889
+ export interface NumericCondition {
2890
+ numeric?: (string | number)[];
2891
+ }
2892
+ /**
2893
+ * Mapping operation nodes are either primitive values or operation node objects
2894
+ */
2895
+ export type OperationNode = /* Mapping operation nodes are either primitive values or operation node objects */ OperationObjectNode | PrimitiveJSONValue;
2896
+ export interface OperationObjectNode {
2897
+ [name: string]: any;
2898
+ _set?: PrimitiveJSONValue;
2899
+ /**
2900
+ * Append to array
2901
+ */
2902
+ _append?: any;
2903
+ /**
2904
+ * Unique array
2905
+ */
2906
+ _uniq?: /* Unique array */ boolean | string[];
2907
+ /**
2908
+ * Copy JSONPath value from source entity context
2909
+ * example:
2910
+ * contact.first_name
2911
+ */
2912
+ _copy?: string;
2913
+ }
2914
+ export interface OrCondition {
2915
+ $or?: FilterConditionOnEvent[];
2916
+ }
2917
+ export interface OrConditionForDiff {
2918
+ $or?: (DiffAdded | DiffUpdated | DiffDeleted)[];
2919
+ }
2920
+ /**
2921
+ * example:
2922
+ * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
2923
+ */
2924
+ export type OrganizationId = string;
2925
+ export interface PatchBulkJobRequest {
2926
+ action: "APPROVE" | "CANCEL";
2927
+ task_token: string;
2928
+ }
2929
+ export interface PrefixCondition {
2930
+ prefix?: string;
2931
+ }
2932
+ export type PrimitiveJSONValue = any;
2933
+ export interface ReceivedEmailTrigger {
2934
+ /**
2935
+ * example:
2936
+ * 12d4f45a-1883-4841-a94c-5928cb338a94
2937
+ */
2938
+ id?: string; // uuid
2939
+ type: "received_email";
2940
+ configuration: {
2941
+ message_type?: "RECEIVED";
2942
+ };
2943
+ }
2944
+ export interface RelationAttribute {
2945
+ /**
2946
+ * Target attribute to store the relation in
2947
+ */
2948
+ target: string;
2949
+ /**
2950
+ * Relation tags (labels) to set for the stored relations
2951
+ */
2952
+ target_tags?: string[];
2953
+ /**
2954
+ * Include all relation tags (labels) present on the main entity relation
2955
+ */
2956
+ target_tags_include_source?: boolean;
2957
+ /**
2958
+ * A filter to identify which source entities to pick as relations from main entity
2959
+ */
2960
+ source_filter?: {
2961
+ /**
2962
+ * Limit relations to maximum number (default, all matched relations)
2963
+ */
2964
+ limit?: number;
2965
+ /**
2966
+ * Filter by specific schema
2967
+ */
2968
+ schema?: string;
2969
+ /**
2970
+ * Filter by a specific relation attribute on the main entity
2971
+ */
2972
+ attribute?: string;
2973
+ /**
2974
+ * Filter by relation tag (label) on the main entity
2975
+ */
2976
+ relation_tag?: string;
2977
+ /**
2978
+ * Filter by a specific tag on the related entity
2979
+ */
2980
+ tag?: string;
2981
+ /**
2982
+ * Picks main entity as relation (overrides other filters)
2983
+ */
2984
+ self?: boolean;
2985
+ };
2986
+ related_to?: {
2987
+ [name: string]: any;
2988
+ };
2989
+ mode: "append" | "prepend" | "set";
2990
+ }
2991
+ export interface ResumeReq {
2992
+ resume_token: /**
2993
+ * A unique token to resume a paused automation execution
2994
+ * example:
2995
+ * eyJraWQiOiJrZXkifQ==
2996
+ */
2997
+ ResumeToken;
2998
+ }
2999
+ export interface ResumeResp {
3000
+ execution: AutomationExecution;
3001
+ resumedAction: AnyAction;
3002
+ }
3003
+ /**
3004
+ * A unique token to resume a paused automation execution
3005
+ * example:
3006
+ * eyJraWQiOiJrZXkifQ==
3007
+ */
3008
+ export type ResumeToken = string;
3009
+ export interface RetryReq {
3010
+ /**
3011
+ * The condition id to retry when retry strategy is RETRY_ALL_PARENT_CONDITION_ACTIONS
3012
+ */
3013
+ condition_id?: string;
3014
+ retry_strategy?: /* different behaviors for retrying failed execution actions. */ RetryStrategy;
3015
+ }
3016
+ /**
3017
+ * different behaviors for retrying failed execution actions.
3018
+ */
3019
+ export type RetryStrategy = "RETRY_AND_RESUME" | "RETRY_AND_STOP" | "RETRY_ALL_PARENT_CONDITION_ACTIONS";
3020
+ export interface SearchAutomationsResp {
3021
+ total: number;
3022
+ results: AutomationFlow[];
3023
+ }
3024
+ export interface SendEmailAction {
3025
+ id?: /**
3026
+ * example:
3027
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
3028
+ */
3029
+ AutomationActionId;
3030
+ flow_action_id?: /**
3031
+ * example:
3032
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
3033
+ */
3034
+ AutomationActionId;
3035
+ name?: string;
3036
+ type?: "send-email";
3037
+ config?: SendEmailConfig;
3038
+ /**
3039
+ * Whether to stop execution in a failed state if this action fails
3040
+ */
3041
+ allow_failure?: boolean;
3042
+ /**
3043
+ * Flag indicating whether the action was created automatically or manually
3044
+ */
3045
+ created_automatically?: boolean;
3046
+ /**
3047
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
3048
+ */
3049
+ is_bulk_action?: boolean;
3050
+ reason?: {
3051
+ /**
3052
+ * Why the action has to be skipped/failed
3053
+ * example:
3054
+ * There are no registered portal users for the given emails, hence skipping the action
3055
+ */
3056
+ message?: string;
3057
+ /**
3058
+ * Extra metadata about the skipping reason - such as a certain condition not met, etc.
3059
+ */
3060
+ payload?: {
3061
+ [name: string]: any;
3062
+ };
3063
+ };
3064
+ /**
3065
+ * Condition Id to be checked before executing the action
3066
+ */
3067
+ condition_id?: string;
3068
+ /**
3069
+ * Schedule Id which indicates the schedule of the action
3070
+ */
3071
+ schedule_id?: string;
3072
+ execution_status?: ExecutionStatus;
3073
+ started_at?: string;
3074
+ updated_at?: string;
3075
+ /**
3076
+ * example:
3077
+ * {}
3078
+ */
3079
+ outputs?: {
3080
+ [name: string]: any;
3081
+ };
3082
+ error_output?: ErrorOutput;
3083
+ retry_strategy?: /* different behaviors for retrying failed execution actions. */ RetryStrategy;
3084
+ }
3085
+ /**
3086
+ * example:
3087
+ * {
3088
+ * "id": "25jga0-gkasl26-0asg-908sgaj2",
3089
+ * "name": "Send Email",
3090
+ * "type": "send-email",
3091
+ * "config": {
3092
+ * "email_template_id": "gasj02-29ug9asgm-29t9gsaghg2g-pkmbhx2",
3093
+ * "language_code": "de"
3094
+ * }
3095
+ * }
3096
+ */
3097
+ export interface SendEmailActionConfig {
3098
+ id?: /**
3099
+ * example:
3100
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
3101
+ */
3102
+ AutomationActionId;
3103
+ flow_action_id?: /**
3104
+ * example:
3105
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
3106
+ */
3107
+ AutomationActionId;
3108
+ name?: string;
3109
+ type?: "send-email";
3110
+ config?: SendEmailConfig;
3111
+ /**
3112
+ * Whether to stop execution in a failed state if this action fails
3113
+ */
3114
+ allow_failure?: boolean;
3115
+ /**
3116
+ * Flag indicating whether the action was created automatically or manually
3117
+ */
3118
+ created_automatically?: boolean;
3119
+ /**
3120
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
3121
+ */
3122
+ is_bulk_action?: boolean;
3123
+ reason?: {
3124
+ /**
3125
+ * Why the action has to be skipped/failed
3126
+ * example:
3127
+ * There are no registered portal users for the given emails, hence skipping the action
3128
+ */
3129
+ message?: string;
3130
+ /**
3131
+ * Extra metadata about the skipping reason - such as a certain condition not met, etc.
3132
+ */
3133
+ payload?: {
3134
+ [name: string]: any;
3135
+ };
3136
+ };
3137
+ /**
3138
+ * Condition Id to be checked before executing the action
3139
+ */
3140
+ condition_id?: string;
3141
+ /**
3142
+ * Schedule Id which indicates the schedule of the action
3143
+ */
3144
+ schedule_id?: string;
3145
+ }
3146
+ export interface SendEmailCondition {
3147
+ _equals?: {
3148
+ source?: string;
3149
+ value?: string;
3150
+ };
3151
+ }
3152
+ export interface SendEmailConfig {
3153
+ email_template_id?: string;
3154
+ language_code?: "de" | "en";
3155
+ /**
3156
+ * Send an email exclusively to the portal user if they are registered on the portal.
3157
+ */
3158
+ notify_portal_user_only?: boolean;
3159
+ /**
3160
+ * When true, it lets to send only the email by skip creating the thread & message entities.
3161
+ */
3162
+ skip_creating_entities?: boolean;
3163
+ /**
3164
+ * Pause automation execution after sending email to wait for a confirmation link to be clicked.
3165
+ *
3166
+ * The email template should contain a confirmation link using the variable `{{confirmation_url}}`
3167
+ *
3168
+ */
3169
+ wait_for_confirmation?: boolean;
3170
+ /**
3171
+ * Include extra file attachments in sent email.
3172
+ * Attachments in email template will be sent regardless of this configuration.
3173
+ *
3174
+ */
3175
+ attachments?: {
3176
+ /**
3177
+ * Specify filters to match file entities related to main entity
3178
+ */
3179
+ source_filter?: {
3180
+ /**
3181
+ * Limit files to maximum number (default, all matched file relations)
3182
+ * example:
3183
+ * 1
3184
+ */
3185
+ limit?: number;
3186
+ /**
3187
+ * Match by filename. Regex syntax supported
3188
+ * example:
3189
+ * .*
3190
+ */
3191
+ filename_regex?: string;
3192
+ /**
3193
+ * Filter by a specific relation attribute on the main entity
3194
+ * example:
3195
+ * _files
3196
+ */
3197
+ attribute?: string;
3198
+ /**
3199
+ * Filter by relation tag (label) on the main entity
3200
+ * example:
3201
+ * contract
3202
+ */
3203
+ relation_tag?: string;
3204
+ /**
3205
+ * Filter by a specific tag on the related file entity
3206
+ */
3207
+ tag?: string;
3208
+ /**
3209
+ * Filter by a specific document type (e.g. document)
3210
+ */
3211
+ document_type?: "document" | "text" | "image" | "video" | "audio" | "spreadsheet" | "presentation" | "font" | "archive" | "application" | "unknown";
3212
+ /**
3213
+ * Picks main entity as file (only works if source entity is a file)
3214
+ */
3215
+ self?: boolean;
3216
+ };
3217
+ }[];
3218
+ /**
3219
+ * Conditions necessary to send out email. Otherwise it will be skipped
3220
+ */
3221
+ conditions?: SendEmailCondition[];
3222
+ }
3223
+ export interface SetValueMapper {
3224
+ mode: /**
3225
+ * - 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 together with value property.
3226
+ *
3227
+ */
3228
+ MappingAttributeMode;
3229
+ /**
3230
+ * JSON like target path for the attribute. Eg. last_name
3231
+ */
3232
+ target: string;
3233
+ /**
3234
+ * Any value to be set: string, number, string[], number[], JSON object, etc. It will override existing values, if any.
3235
+ *
3236
+ */
3237
+ value: any;
3238
+ }
3239
+ export interface StartExecutionRequest {
3240
+ entity_id: /**
3241
+ * example:
3242
+ * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
3243
+ */
3244
+ EntityId;
3245
+ flow_id: /**
3246
+ * ID of the Automation Flow
3247
+ * example:
3248
+ * 7791b04a-16d2-44a2-9af9-2d59c25c512f
3249
+ */
3250
+ AutomationFlowId;
3251
+ workflow_context?: WorkflowExecutionContext;
3252
+ /**
3253
+ * Use workflow_context.workflow_exec_id instead
3254
+ */
3255
+ flow_execution_id?: string;
3256
+ /**
3257
+ * Use workflow_context.workflow_exec_task_id instead
3258
+ */
3259
+ flow_automation_task_id?: string;
3260
+ }
3261
+ export interface SuffixCondition {
3262
+ suffix?: string;
3263
+ }
3264
+ /**
3265
+ * example:
3266
+ * {
3267
+ * "source": "billing_contact.email",
3268
+ * "comparison": "exists"
3269
+ * }
3270
+ */
3271
+ export interface TriggerCondition {
3272
+ source: string;
3273
+ comparison: Comparison;
3274
+ value?: string | number | string[] | number[];
3275
+ }
3276
+ /**
3277
+ * 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.
3278
+ * example:
3279
+ * {
3280
+ * "entity_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
3281
+ * }
3282
+ */
3283
+ export interface TriggerContext {
3284
+ [name: string]: string;
3285
+ }
3286
+ export interface TriggerEventAction {
3287
+ id?: /**
3288
+ * example:
3289
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
3290
+ */
3291
+ AutomationActionId;
3292
+ flow_action_id?: /**
3293
+ * example:
3294
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
3295
+ */
3296
+ AutomationActionId;
3297
+ name?: string;
3298
+ type?: "trigger-event";
3299
+ config?: /* Configuration for triggering an event catalog event */ TriggerEventConfig;
3300
+ /**
3301
+ * Whether to stop execution in a failed state if this action fails
3302
+ */
3303
+ allow_failure?: boolean;
3304
+ /**
3305
+ * Flag indicating whether the action was created automatically or manually
3306
+ */
3307
+ created_automatically?: boolean;
3308
+ /**
3309
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
3310
+ */
3311
+ is_bulk_action?: boolean;
3312
+ reason?: {
3313
+ /**
3314
+ * Why the action has to be skipped/failed
3315
+ * example:
3316
+ * There are no registered portal users for the given emails, hence skipping the action
3317
+ */
3318
+ message?: string;
3319
+ /**
3320
+ * Extra metadata about the skipping reason - such as a certain condition not met, etc.
3321
+ */
3322
+ payload?: {
3323
+ [name: string]: any;
3324
+ };
3325
+ };
3326
+ /**
3327
+ * Condition Id to be checked before executing the action
3328
+ */
3329
+ condition_id?: string;
3330
+ /**
3331
+ * Schedule Id which indicates the schedule of the action
3332
+ */
3333
+ schedule_id?: string;
3334
+ execution_status?: ExecutionStatus;
3335
+ started_at?: string;
3336
+ updated_at?: string;
3337
+ /**
3338
+ * example:
3339
+ * {}
3340
+ */
3341
+ outputs?: {
3342
+ [name: string]: any;
3343
+ };
3344
+ error_output?: ErrorOutput;
3345
+ retry_strategy?: /* different behaviors for retrying failed execution actions. */ RetryStrategy;
3346
+ }
3347
+ /**
3348
+ * example:
3349
+ * {
3350
+ * "id": "2520gja-2sgmsaga-0asg-822jgal",
3351
+ * "name": "Trigger Event",
3352
+ * "type": "trigger-event",
3353
+ * "config": {
3354
+ * "event_name": "my_custom_event",
3355
+ * "event_inputs": {
3356
+ * "key": "value"
3357
+ * }
3358
+ * }
3359
+ * }
3360
+ */
3361
+ export interface TriggerEventActionConfig {
3362
+ id?: /**
3363
+ * example:
3364
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
3365
+ */
3366
+ AutomationActionId;
3367
+ flow_action_id?: /**
3368
+ * example:
3369
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
3370
+ */
3371
+ AutomationActionId;
3372
+ name?: string;
3373
+ type?: "trigger-event";
3374
+ config?: /* Configuration for triggering an event catalog event */ TriggerEventConfig;
3375
+ /**
3376
+ * Whether to stop execution in a failed state if this action fails
3377
+ */
3378
+ allow_failure?: boolean;
3379
+ /**
3380
+ * Flag indicating whether the action was created automatically or manually
3381
+ */
3382
+ created_automatically?: boolean;
3383
+ /**
3384
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
3385
+ */
3386
+ is_bulk_action?: boolean;
3387
+ reason?: {
3388
+ /**
3389
+ * Why the action has to be skipped/failed
3390
+ * example:
3391
+ * There are no registered portal users for the given emails, hence skipping the action
3392
+ */
3393
+ message?: string;
3394
+ /**
3395
+ * Extra metadata about the skipping reason - such as a certain condition not met, etc.
3396
+ */
3397
+ payload?: {
3398
+ [name: string]: any;
3399
+ };
3400
+ };
3401
+ /**
3402
+ * Condition Id to be checked before executing the action
3403
+ */
3404
+ condition_id?: string;
3405
+ /**
3406
+ * Schedule Id which indicates the schedule of the action
3407
+ */
3408
+ schedule_id?: string;
3409
+ }
3410
+ /**
3411
+ * Configuration for triggering an event catalog event
3412
+ */
3413
+ export interface TriggerEventConfig {
3414
+ /**
3415
+ * The event catalog event name to trigger
3416
+ */
3417
+ event_name: string;
3418
+ /**
3419
+ * Inputs to be passed to trigger the event
3420
+ */
3421
+ event_inputs?: {
3422
+ [name: string]: any;
3423
+ };
3424
+ }
3425
+ export interface TriggerEventEntityActivity {
3426
+ type?: "entity_activity";
3427
+ /**
3428
+ * example:
3429
+ * 123
3430
+ */
3431
+ org_id: string;
3432
+ activity_id: /**
3433
+ * example:
3434
+ * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
3435
+ */
3436
+ ActivityId;
3437
+ activity_type: string;
3438
+ entity_id?: /**
3439
+ * example:
3440
+ * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
3441
+ */
3442
+ EntityId;
3443
+ }
3444
+ export interface TriggerEventEntityOperation {
3445
+ type?: "entity_operation";
3446
+ entity_id: /**
3447
+ * example:
3448
+ * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
3449
+ */
3450
+ EntityId;
3451
+ /**
3452
+ * example:
3453
+ * 123
3454
+ */
3455
+ org_id: string;
3456
+ activity_id: /**
3457
+ * example:
3458
+ * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
3459
+ */
3460
+ ActivityId;
3461
+ operation_type: EntityOperation;
3462
+ }
3463
+ export interface TriggerEventFlowAutomationTask {
3464
+ type?: "flow_automation_task";
3465
+ /**
3466
+ * example:
3467
+ * 123
3468
+ */
3469
+ org_id: string;
3470
+ entity_id: /**
3471
+ * example:
3472
+ * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
3473
+ */
3474
+ EntityId;
3475
+ /**
3476
+ * example:
3477
+ * wfwAJoT_cK
3478
+ */
3479
+ flow_execution_id: string;
3480
+ /**
3481
+ * example:
3482
+ * 2fa221ec-3aac-4655-ab8f-c062eca44a3
3483
+ */
3484
+ flow_automation_task_id: string; // UUID
3485
+ caller?: ApiCallerContext;
3486
+ }
3487
+ export interface TriggerEventManual {
3488
+ type?: "manual";
3489
+ /**
3490
+ * example:
3491
+ * 123
3492
+ */
3493
+ org_id: string;
3494
+ entity_id: /**
3495
+ * example:
3496
+ * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
3497
+ */
3498
+ EntityId;
3499
+ caller?: ApiCallerContext;
3500
+ }
3501
+ export interface TriggerEventMessaging {
3502
+ type?: "new_email_thread";
3503
+ /**
3504
+ * example:
3505
+ * 123
3506
+ */
3507
+ org_id: string;
3508
+ thread_id: string;
3509
+ message_id: string;
3510
+ entity_id: /**
3511
+ * example:
3512
+ * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
3513
+ */
3514
+ EntityId;
3515
+ }
3516
+ export interface TriggerShareEntityAction {
3517
+ id?: /**
3518
+ * example:
3519
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
3520
+ */
3521
+ AutomationActionId;
3522
+ flow_action_id?: /**
3523
+ * example:
3524
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
3525
+ */
3526
+ AutomationActionId;
3527
+ name?: string;
3528
+ type?: "trigger-share-entity";
3529
+ config?: TriggerShareEntityConfig;
3530
+ /**
3531
+ * Whether to stop execution in a failed state if this action fails
3532
+ */
3533
+ allow_failure?: boolean;
3534
+ /**
3535
+ * Flag indicating whether the action was created automatically or manually
3536
+ */
3537
+ created_automatically?: boolean;
3538
+ /**
3539
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
3540
+ */
3541
+ is_bulk_action?: boolean;
3542
+ reason?: {
3543
+ /**
3544
+ * Why the action has to be skipped/failed
3545
+ * example:
3546
+ * There are no registered portal users for the given emails, hence skipping the action
3547
+ */
3548
+ message?: string;
3549
+ /**
3550
+ * Extra metadata about the skipping reason - such as a certain condition not met, etc.
3551
+ */
3552
+ payload?: {
3553
+ [name: string]: any;
3554
+ };
3555
+ };
3556
+ /**
3557
+ * Condition Id to be checked before executing the action
3558
+ */
3559
+ condition_id?: string;
3560
+ /**
3561
+ * Schedule Id which indicates the schedule of the action
3562
+ */
3563
+ schedule_id?: string;
3564
+ execution_status?: ExecutionStatus;
3565
+ started_at?: string;
3566
+ updated_at?: string;
3567
+ /**
3568
+ * example:
3569
+ * {}
3570
+ */
3571
+ outputs?: {
3572
+ [name: string]: any;
3573
+ };
3574
+ error_output?: ErrorOutput;
3575
+ retry_strategy?: /* different behaviors for retrying failed execution actions. */ RetryStrategy;
3576
+ }
3577
+ export interface TriggerShareEntityActionConfig {
3578
+ id?: /**
3579
+ * example:
3580
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
3581
+ */
3582
+ AutomationActionId;
3583
+ flow_action_id?: /**
3584
+ * example:
3585
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
3586
+ */
3587
+ AutomationActionId;
3588
+ name?: string;
3589
+ type?: "trigger-workflow";
3590
+ config?: TriggerShareEntityConfig;
3591
+ /**
3592
+ * Whether to stop execution in a failed state if this action fails
3593
+ */
3594
+ allow_failure?: boolean;
3595
+ /**
3596
+ * Flag indicating whether the action was created automatically or manually
3597
+ */
3598
+ created_automatically?: boolean;
3599
+ /**
3600
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
3601
+ */
3602
+ is_bulk_action?: boolean;
3603
+ reason?: {
3604
+ /**
3605
+ * Why the action has to be skipped/failed
3606
+ * example:
3607
+ * There are no registered portal users for the given emails, hence skipping the action
3608
+ */
3609
+ message?: string;
3610
+ /**
3611
+ * Extra metadata about the skipping reason - such as a certain condition not met, etc.
3612
+ */
3613
+ payload?: {
3614
+ [name: string]: any;
3615
+ };
3616
+ };
3617
+ /**
3618
+ * Condition Id to be checked before executing the action
3619
+ */
3620
+ condition_id?: string;
3621
+ /**
3622
+ * Schedule Id which indicates the schedule of the action
3623
+ */
3624
+ schedule_id?: string;
3625
+ }
3626
+ export interface TriggerShareEntityConfig {
3627
+ partner_org_ids?: string[];
3628
+ }
3629
+ export interface TriggerWebhookAction {
3630
+ id?: /**
3631
+ * example:
3632
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
3633
+ */
3634
+ AutomationActionId;
3635
+ flow_action_id?: /**
3636
+ * example:
3637
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
3638
+ */
3639
+ AutomationActionId;
3640
+ name?: string;
3641
+ type?: "trigger-webhook";
3642
+ config?: TriggerWebhookConfig;
3643
+ /**
3644
+ * Whether to stop execution in a failed state if this action fails
3645
+ */
3646
+ allow_failure?: boolean;
3647
+ /**
3648
+ * Flag indicating whether the action was created automatically or manually
3649
+ */
3650
+ created_automatically?: boolean;
3651
+ /**
3652
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
3653
+ */
3654
+ is_bulk_action?: boolean;
3655
+ reason?: {
3656
+ /**
3657
+ * Why the action has to be skipped/failed
3658
+ * example:
3659
+ * There are no registered portal users for the given emails, hence skipping the action
3660
+ */
3661
+ message?: string;
3662
+ /**
3663
+ * Extra metadata about the skipping reason - such as a certain condition not met, etc.
3664
+ */
3665
+ payload?: {
3666
+ [name: string]: any;
3667
+ };
3668
+ };
3669
+ /**
3670
+ * Condition Id to be checked before executing the action
3671
+ */
3672
+ condition_id?: string;
3673
+ /**
3674
+ * Schedule Id which indicates the schedule of the action
3675
+ */
3676
+ schedule_id?: string;
3677
+ execution_status?: ExecutionStatus;
3678
+ started_at?: string;
3679
+ updated_at?: string;
3680
+ /**
3681
+ * example:
3682
+ * {}
3683
+ */
3684
+ outputs?: {
3685
+ [name: string]: any;
3686
+ };
3687
+ error_output?: ErrorOutput;
3688
+ retry_strategy?: /* different behaviors for retrying failed execution actions. */ RetryStrategy;
3689
+ }
3690
+ /**
3691
+ * example:
3692
+ * {
3693
+ * "id": "2520gja-2sgmsaga-0asg-822jgal",
3694
+ * "name": "Trigger Webhook",
3695
+ * "type": "trigger-webhook",
3696
+ * "config": {
3697
+ * "entity_sources": [
3698
+ * "contact",
3699
+ * "account"
3700
+ * ],
3701
+ * "target_webhook_id": "25jg9ag2ga"
3702
+ * }
3703
+ * }
3704
+ */
3705
+ export interface TriggerWebhookActionConfig {
3706
+ id?: /**
3707
+ * example:
3708
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
3709
+ */
3710
+ AutomationActionId;
3711
+ flow_action_id?: /**
3712
+ * example:
3713
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
3714
+ */
3715
+ AutomationActionId;
3716
+ name?: string;
3717
+ type?: "trigger-webhook";
3718
+ config?: TriggerWebhookConfig;
3719
+ /**
3720
+ * Whether to stop execution in a failed state if this action fails
3721
+ */
3722
+ allow_failure?: boolean;
3723
+ /**
3724
+ * Flag indicating whether the action was created automatically or manually
3725
+ */
3726
+ created_automatically?: boolean;
3727
+ /**
3728
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
3729
+ */
3730
+ is_bulk_action?: boolean;
3731
+ reason?: {
3732
+ /**
3733
+ * Why the action has to be skipped/failed
3734
+ * example:
3735
+ * There are no registered portal users for the given emails, hence skipping the action
3736
+ */
3737
+ message?: string;
3738
+ /**
3739
+ * Extra metadata about the skipping reason - such as a certain condition not met, etc.
3740
+ */
3741
+ payload?: {
3742
+ [name: string]: any;
3743
+ };
3744
+ };
3745
+ /**
3746
+ * Condition Id to be checked before executing the action
3747
+ */
3748
+ condition_id?: string;
3749
+ /**
3750
+ * Schedule Id which indicates the schedule of the action
3751
+ */
3752
+ schedule_id?: string;
3753
+ }
3754
+ export interface TriggerWebhookConfig {
3755
+ /**
3756
+ * The latest webhook event_id for an execution of this action
3757
+ */
3758
+ event_id?: string;
3759
+ entity_sources?: string[];
3760
+ target_webhook_id?: string;
3761
+ /**
3762
+ * Whether to wait for the request to finish before continuing automation execution
3763
+ */
3764
+ sync?: boolean;
3765
+ }
3766
+ export interface TriggerWorkflowAction {
3767
+ id?: /**
3768
+ * example:
3769
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
3770
+ */
3771
+ AutomationActionId;
3772
+ flow_action_id?: /**
3773
+ * example:
3774
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
3775
+ */
3776
+ AutomationActionId;
3777
+ name?: string;
3778
+ type?: "trigger-workflow";
3779
+ config?: TriggerWorkflowConfig;
3780
+ /**
3781
+ * Whether to stop execution in a failed state if this action fails
3782
+ */
3783
+ allow_failure?: boolean;
3784
+ /**
3785
+ * Flag indicating whether the action was created automatically or manually
3786
+ */
3787
+ created_automatically?: boolean;
3788
+ /**
3789
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
3790
+ */
3791
+ is_bulk_action?: boolean;
3792
+ reason?: {
3793
+ /**
3794
+ * Why the action has to be skipped/failed
3795
+ * example:
3796
+ * There are no registered portal users for the given emails, hence skipping the action
3797
+ */
3798
+ message?: string;
3799
+ /**
3800
+ * Extra metadata about the skipping reason - such as a certain condition not met, etc.
3801
+ */
3802
+ payload?: {
3803
+ [name: string]: any;
3804
+ };
3805
+ };
3806
+ /**
3807
+ * Condition Id to be checked before executing the action
3808
+ */
3809
+ condition_id?: string;
3810
+ /**
3811
+ * Schedule Id which indicates the schedule of the action
3812
+ */
3813
+ schedule_id?: string;
3814
+ execution_status?: ExecutionStatus;
3815
+ started_at?: string;
3816
+ updated_at?: string;
3817
+ /**
3818
+ * example:
3819
+ * {}
3820
+ */
3821
+ outputs?: {
3822
+ [name: string]: any;
3823
+ };
3824
+ error_output?: ErrorOutput;
3825
+ retry_strategy?: /* different behaviors for retrying failed execution actions. */ RetryStrategy;
3826
+ }
3827
+ /**
3828
+ * example:
3829
+ * {
3830
+ * "id": "08g988-ojt2jtaga-292h-8978gsaga",
3831
+ * "name": "Trigger Workflow",
3832
+ * "type": "trigger-workflow",
3833
+ * "config": {
3834
+ * "target_workflow": "mfptvUMH",
3835
+ * "conditions": [
3836
+ * {
3837
+ * "schema": "ivy-opportunity",
3838
+ * "source": "customer.type",
3839
+ * "comparison": "equals",
3840
+ * "value": "PRIVATE"
3841
+ * }
3842
+ * ],
3843
+ * "assign_steps": [
3844
+ * {
3845
+ * "step_name": "Lead Sales",
3846
+ * "user_ids": [
3847
+ * 10010729
3848
+ * ]
3849
+ * },
3850
+ * {
3851
+ * "step_name": "Operations",
3852
+ * "user_ids": [
3853
+ * 10010728,
3854
+ * 10010729
3855
+ * ]
3856
+ * }
3857
+ * ]
3858
+ * }
3859
+ * }
3860
+ */
3861
+ export interface TriggerWorkflowActionConfig {
3862
+ id?: /**
3863
+ * example:
3864
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
3865
+ */
3866
+ AutomationActionId;
3867
+ flow_action_id?: /**
3868
+ * example:
3869
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
3870
+ */
3871
+ AutomationActionId;
3872
+ name?: string;
3873
+ type?: "trigger-workflow";
3874
+ config?: TriggerWorkflowConfig;
3875
+ /**
3876
+ * Whether to stop execution in a failed state if this action fails
3877
+ */
3878
+ allow_failure?: boolean;
3879
+ /**
3880
+ * Flag indicating whether the action was created automatically or manually
3881
+ */
3882
+ created_automatically?: boolean;
3883
+ /**
3884
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
3885
+ */
3886
+ is_bulk_action?: boolean;
3887
+ reason?: {
3888
+ /**
3889
+ * Why the action has to be skipped/failed
3890
+ * example:
3891
+ * There are no registered portal users for the given emails, hence skipping the action
3892
+ */
3893
+ message?: string;
3894
+ /**
3895
+ * Extra metadata about the skipping reason - such as a certain condition not met, etc.
3896
+ */
3897
+ payload?: {
3898
+ [name: string]: any;
3899
+ };
3900
+ };
3901
+ /**
3902
+ * Condition Id to be checked before executing the action
3903
+ */
3904
+ condition_id?: string;
3905
+ /**
3906
+ * Schedule Id which indicates the schedule of the action
3907
+ */
3908
+ schedule_id?: string;
3909
+ }
3910
+ /**
3911
+ * example:
3912
+ * {
3913
+ * "source": "email",
3914
+ * "comparison": "equals",
3915
+ * "schema": "contact",
3916
+ * "value": "test@epilot.cloud"
3917
+ * }
3918
+ */
3919
+ export interface TriggerWorkflowCondition {
3920
+ source: string;
3921
+ comparison: Comparison;
3922
+ value?: string | number | string[] | number[];
3923
+ schema: string;
3924
+ }
3925
+ export interface TriggerWorkflowConfig {
3926
+ target_workflow?: string;
3927
+ conditions?: /**
3928
+ * example:
3929
+ * {
3930
+ * "source": "email",
3931
+ * "comparison": "equals",
3932
+ * "schema": "contact",
3933
+ * "value": "test@epilot.cloud"
3934
+ * }
3935
+ */
3936
+ TriggerWorkflowCondition[];
3937
+ assignees?: string[];
3938
+ assign_steps?: /**
3939
+ * example:
3940
+ * [
3941
+ * {
3942
+ * "step_id": "xyh9t2ha",
3943
+ * "step_name": "Lead Sales",
3944
+ * "user_ids": [
3945
+ * 10010729
3946
+ * ]
3947
+ * },
3948
+ * {
3949
+ * "step_id": "29jgasl",
3950
+ * "step_name": "Operations",
3951
+ * "user_ids": [
3952
+ * 10010728,
3953
+ * 10010729
3954
+ * ]
3955
+ * }
3956
+ * ]
3957
+ */
3958
+ AssignUsersToStep[];
3959
+ filter_with_purposes?: boolean;
3960
+ }
3961
+ export interface WildcardCondition {
3962
+ wildcard?: string;
3963
+ }
3964
+ /**
3965
+ * For automation that are connected to workflows V2, this field tracks various information about the workflow.
3966
+ */
3967
+ export interface WorkflowContext {
3968
+ /**
3969
+ * The ID of the workflow this automation is connected to
3970
+ */
3971
+ workflow_id: string; // uuid
3972
+ /**
3973
+ * The ID of the task in the workflow that this automation is connected to
3974
+ */
3975
+ task_id?: string; // uuid
3976
+ workflow_role: /* The role this automation plays in the workflow. */ WorkflowContextRole;
3977
+ }
3978
+ /**
3979
+ * The role this automation plays in the workflow.
3980
+ */
3981
+ export type WorkflowContextRole = "trigger_workflow" | "run_task_automation";
3982
+ export interface WorkflowExecutionContext {
3983
+ workflow_exec_id: string;
3984
+ workflow_exec_task_id?: string;
3985
+ workflow_role: /* The role this automation plays in the workflow. */ WorkflowContextRole;
3986
+ _execution_chain?: /* [Internal] Tracks execution chain for infinite loop prevention. This is an internal property and should not be used by external consumers. */ ExecutionChain;
3987
+ }
3988
+ }
3989
+ }
3990
+ declare namespace Paths {
3991
+ namespace BatchGetFlows {
3992
+ export interface RequestBody {
3993
+ ids?: /**
3994
+ * ID of the Automation Flow
3995
+ * example:
3996
+ * 7791b04a-16d2-44a2-9af9-2d59c25c512f
3997
+ */
3998
+ Components.Schemas.AutomationFlowId[];
3999
+ }
4000
+ namespace Responses {
4001
+ export type $200 = Components.Schemas.SearchAutomationsResp;
4002
+ export type $403 = /**
4003
+ * example:
4004
+ * {
4005
+ * "status": 403,
4006
+ * "error": "Forbidden"
4007
+ * }
4008
+ */
4009
+ Components.Responses.ForbiddenError;
4010
+ }
4011
+ }
4012
+ namespace BulkTriggerExecutions {
4013
+ export type RequestBody = Components.Schemas.BulkTriggerRequest;
4014
+ namespace Responses {
4015
+ export type $202 = Components.Schemas.BulkTriggerJob;
4016
+ export type $403 = /**
4017
+ * example:
4018
+ * {
4019
+ * "status": 403,
4020
+ * "error": "Forbidden"
4021
+ * }
4022
+ */
4023
+ Components.Responses.ForbiddenError;
4024
+ }
4025
+ }
4026
+ namespace CancelExecution {
4027
+ namespace Parameters {
4028
+ export type ExecutionId = /**
4029
+ * example:
4030
+ * 9baf184f-bc81-4128-bca3-d974c90a12c4
4031
+ */
4032
+ Components.Schemas.AutomationExecutionId;
4033
+ }
4034
+ export interface PathParameters {
4035
+ execution_id: Parameters.ExecutionId;
4036
+ }
4037
+ namespace Responses {
4038
+ export type $200 = Components.Schemas.AutomationExecution;
4039
+ export type $403 = /**
4040
+ * example:
4041
+ * {
4042
+ * "status": 403,
4043
+ * "error": "Forbidden"
4044
+ * }
4045
+ */
4046
+ Components.Responses.ForbiddenError;
4047
+ export type $404 = /**
4048
+ * example:
4049
+ * {
4050
+ * "status": 404,
4051
+ * "error": "Not Found"
4052
+ * }
4053
+ */
4054
+ Components.Responses.NotFoundError;
4055
+ }
4056
+ }
4057
+ namespace CancelSchedule {
4058
+ namespace Parameters {
4059
+ export type ExecutionId = /**
4060
+ * example:
4061
+ * 9baf184f-bc81-4128-bca3-d974c90a12c4
4062
+ */
4063
+ Components.Schemas.AutomationExecutionId;
4064
+ export type ScheduleId = string;
4065
+ }
4066
+ export interface PathParameters {
4067
+ execution_id: Parameters.ExecutionId;
4068
+ schedule_id: Parameters.ScheduleId;
4069
+ }
4070
+ namespace Responses {
4071
+ export type $200 = Components.Schemas.ActionSchedule;
4072
+ export type $403 = /**
4073
+ * example:
4074
+ * {
4075
+ * "status": 403,
4076
+ * "error": "Forbidden"
4077
+ * }
4078
+ */
4079
+ Components.Responses.ForbiddenError;
4080
+ export type $404 = /**
4081
+ * example:
4082
+ * {
4083
+ * "status": 404,
4084
+ * "error": "Not Found"
4085
+ * }
4086
+ */
4087
+ Components.Responses.NotFoundError;
4088
+ }
4089
+ }
4090
+ namespace CreateFlow {
4091
+ export type RequestBody = Components.Schemas.AutomationFlow;
4092
+ namespace Responses {
4093
+ export type $201 = Components.Schemas.AutomationFlow;
4094
+ export type $403 = /**
4095
+ * example:
4096
+ * {
4097
+ * "status": 403,
4098
+ * "error": "Forbidden"
4099
+ * }
4100
+ */
4101
+ Components.Responses.ForbiddenError;
4102
+ }
4103
+ }
4104
+ namespace DeleteFlow {
4105
+ namespace Parameters {
4106
+ export type FlowId = /**
4107
+ * ID of the Automation Flow
4108
+ * example:
4109
+ * 7791b04a-16d2-44a2-9af9-2d59c25c512f
4110
+ */
4111
+ Components.Schemas.AutomationFlowId;
4112
+ }
4113
+ export interface PathParameters {
4114
+ flow_id: Parameters.FlowId;
4115
+ }
4116
+ namespace Responses {
4117
+ export interface $200 {
4118
+ }
4119
+ export type $403 = /**
4120
+ * example:
4121
+ * {
4122
+ * "status": 403,
4123
+ * "error": "Forbidden"
4124
+ * }
4125
+ */
4126
+ Components.Responses.ForbiddenError;
4127
+ export type $404 = /**
4128
+ * example:
4129
+ * {
4130
+ * "status": 404,
4131
+ * "error": "Not Found"
4132
+ * }
4133
+ */
4134
+ Components.Responses.NotFoundError;
4135
+ }
4136
+ }
4137
+ namespace GetBulkJob {
4138
+ namespace Parameters {
4139
+ export type JobId = /**
4140
+ * Job ID for tracking the status of bulk trigger automation executions
4141
+ * example:
4142
+ * 8c086140-f33e-4bb7-a993-50c0f2402c7b
4143
+ */
4144
+ Components.Schemas.JobId;
4145
+ }
4146
+ export interface PathParameters {
4147
+ job_id: Parameters.JobId;
4148
+ }
4149
+ namespace Responses {
4150
+ export type $200 = Components.Schemas.BulkTriggerJob;
4151
+ export type $403 = /**
4152
+ * example:
4153
+ * {
4154
+ * "status": 403,
4155
+ * "error": "Forbidden"
4156
+ * }
4157
+ */
4158
+ Components.Responses.ForbiddenError;
4159
+ export type $404 = /**
4160
+ * example:
4161
+ * {
4162
+ * "status": 404,
4163
+ * "error": "Not Found"
4164
+ * }
4165
+ */
4166
+ Components.Responses.NotFoundError;
4167
+ }
4168
+ }
4169
+ namespace GetExecution {
4170
+ namespace Parameters {
4171
+ export type ExecutionId = /**
4172
+ * example:
4173
+ * 9baf184f-bc81-4128-bca3-d974c90a12c4
4174
+ */
4175
+ Components.Schemas.AutomationExecutionId;
4176
+ }
4177
+ export interface PathParameters {
4178
+ execution_id: Parameters.ExecutionId;
4179
+ }
4180
+ namespace Responses {
4181
+ export type $200 = Components.Schemas.AutomationExecution;
4182
+ export type $403 = /**
4183
+ * example:
4184
+ * {
4185
+ * "status": 403,
4186
+ * "error": "Forbidden"
4187
+ * }
4188
+ */
4189
+ Components.Responses.ForbiddenError;
4190
+ export type $404 = /**
4191
+ * example:
4192
+ * {
4193
+ * "status": 404,
4194
+ * "error": "Not Found"
4195
+ * }
4196
+ */
4197
+ Components.Responses.NotFoundError;
4198
+ }
4199
+ }
4200
+ namespace GetExecutions {
4201
+ namespace Parameters {
4202
+ export type EntityId = /**
4203
+ * example:
4204
+ * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
4205
+ */
4206
+ Components.Schemas.EntityId;
4207
+ export type From = number;
4208
+ export type IncludeFlows = boolean;
4209
+ export type Size = number;
4210
+ }
4211
+ export interface QueryParameters {
4212
+ entity_id?: Parameters.EntityId;
4213
+ size?: Parameters.Size;
4214
+ from?: Parameters.From;
4215
+ include_flows?: Parameters.IncludeFlows;
4216
+ }
4217
+ namespace Responses {
4218
+ export type $200 = Components.Schemas.GetExecutionsResp;
4219
+ export type $403 = /**
4220
+ * example:
4221
+ * {
4222
+ * "status": 403,
4223
+ * "error": "Forbidden"
4224
+ * }
4225
+ */
4226
+ Components.Responses.ForbiddenError;
4227
+ }
4228
+ }
4229
+ namespace GetFlow {
4230
+ namespace Parameters {
4231
+ export type FlowId = /**
4232
+ * ID of the Automation Flow
4233
+ * example:
4234
+ * 7791b04a-16d2-44a2-9af9-2d59c25c512f
4235
+ */
4236
+ Components.Schemas.AutomationFlowId;
4237
+ }
4238
+ export interface PathParameters {
4239
+ flow_id: Parameters.FlowId;
4240
+ }
4241
+ namespace Responses {
4242
+ export type $200 = Components.Schemas.AutomationFlow;
4243
+ export type $403 = /**
4244
+ * example:
4245
+ * {
4246
+ * "status": 403,
4247
+ * "error": "Forbidden"
4248
+ * }
4249
+ */
4250
+ Components.Responses.ForbiddenError;
4251
+ export type $404 = /**
4252
+ * example:
4253
+ * {
4254
+ * "status": 404,
4255
+ * "error": "Not Found"
4256
+ * }
4257
+ */
4258
+ Components.Responses.NotFoundError;
4259
+ }
4260
+ }
4261
+ namespace PatchBulkJob {
4262
+ namespace Parameters {
4263
+ export type JobId = /**
4264
+ * Job ID for tracking the status of bulk trigger automation executions
4265
+ * example:
4266
+ * 8c086140-f33e-4bb7-a993-50c0f2402c7b
4267
+ */
4268
+ Components.Schemas.JobId;
4269
+ }
4270
+ export interface PathParameters {
4271
+ job_id: Parameters.JobId;
4272
+ }
4273
+ export type RequestBody = Components.Schemas.PatchBulkJobRequest;
4274
+ namespace Responses {
4275
+ export type $200 = Components.Schemas.BulkTriggerJob;
4276
+ export type $403 = /**
4277
+ * example:
4278
+ * {
4279
+ * "status": 403,
4280
+ * "error": "Forbidden"
4281
+ * }
4282
+ */
4283
+ Components.Responses.ForbiddenError;
4284
+ export type $404 = /**
4285
+ * example:
4286
+ * {
4287
+ * "status": 404,
4288
+ * "error": "Not Found"
4289
+ * }
4290
+ */
4291
+ Components.Responses.NotFoundError;
4292
+ }
4293
+ }
4294
+ namespace PutFlow {
4295
+ namespace Parameters {
4296
+ export type FlowId = /**
4297
+ * ID of the Automation Flow
4298
+ * example:
4299
+ * 7791b04a-16d2-44a2-9af9-2d59c25c512f
4300
+ */
4301
+ Components.Schemas.AutomationFlowId;
4302
+ }
4303
+ export interface PathParameters {
4304
+ flow_id: Parameters.FlowId;
4305
+ }
4306
+ export type RequestBody = Components.Schemas.AutomationFlow;
4307
+ namespace Responses {
4308
+ export type $200 = Components.Schemas.AutomationFlow;
4309
+ export type $403 = /**
4310
+ * example:
4311
+ * {
4312
+ * "status": 403,
4313
+ * "error": "Forbidden"
4314
+ * }
4315
+ */
4316
+ Components.Responses.ForbiddenError;
4317
+ }
4318
+ }
4319
+ namespace ResumeExecutionWithToken {
4320
+ export type RequestBody = Components.Schemas.ResumeReq;
4321
+ namespace Responses {
4322
+ export type $200 = Components.Schemas.ResumeResp;
4323
+ export interface $400 {
4324
+ }
4325
+ export type $403 = /**
4326
+ * example:
4327
+ * {
4328
+ * "status": 403,
4329
+ * "error": "Forbidden"
4330
+ * }
4331
+ */
4332
+ Components.Responses.ForbiddenError;
4333
+ export type $404 = /**
4334
+ * example:
4335
+ * {
4336
+ * "status": 404,
4337
+ * "error": "Not Found"
4338
+ * }
4339
+ */
4340
+ Components.Responses.NotFoundError;
4341
+ }
4342
+ }
4343
+ namespace RetriggerAction {
4344
+ namespace Parameters {
4345
+ export type ActionId = /**
4346
+ * example:
4347
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
4348
+ */
4349
+ Components.Schemas.AutomationActionId;
4350
+ export type ExecutionId = /**
4351
+ * example:
4352
+ * 9baf184f-bc81-4128-bca3-d974c90a12c4
4353
+ */
4354
+ Components.Schemas.AutomationExecutionId;
4355
+ }
4356
+ export interface PathParameters {
4357
+ execution_id: Parameters.ExecutionId;
4358
+ action_id: Parameters.ActionId;
4359
+ }
4360
+ export type RequestBody = Components.Schemas.RetryReq;
4361
+ namespace Responses {
4362
+ export interface $200 {
4363
+ }
4364
+ export type $403 = /**
4365
+ * example:
4366
+ * {
4367
+ * "status": 403,
4368
+ * "error": "Forbidden"
4369
+ * }
4370
+ */
4371
+ Components.Responses.ForbiddenError;
4372
+ export type $404 = /**
4373
+ * example:
4374
+ * {
4375
+ * "status": 404,
4376
+ * "error": "Not Found"
4377
+ * }
4378
+ */
4379
+ Components.Responses.NotFoundError;
4380
+ }
4381
+ }
4382
+ namespace SearchFlows {
4383
+ namespace Parameters {
4384
+ export type From = number;
4385
+ export type IncludeFlows = boolean;
4386
+ /**
4387
+ * example:
4388
+ * submission
4389
+ */
4390
+ export type Schema = string;
4391
+ export type Size = number;
4392
+ /**
4393
+ * example:
4394
+ * 600945fe-212e-4b97-acf7-391d64648384
4395
+ */
4396
+ export type TriggerSourceId = string;
4397
+ }
4398
+ export interface QueryParameters {
4399
+ schema?: /**
4400
+ * example:
4401
+ * submission
4402
+ */
4403
+ Parameters.Schema;
4404
+ size?: Parameters.Size;
4405
+ from?: Parameters.From;
4406
+ trigger_source_id?: /**
4407
+ * example:
4408
+ * 600945fe-212e-4b97-acf7-391d64648384
4409
+ */
4410
+ Parameters.TriggerSourceId;
4411
+ include_flows?: Parameters.IncludeFlows;
4412
+ }
4413
+ namespace Responses {
4414
+ export type $200 = Components.Schemas.SearchAutomationsResp;
4415
+ }
4416
+ }
4417
+ namespace StartExecution {
4418
+ export type RequestBody = Components.Schemas.StartExecutionRequest;
4419
+ namespace Responses {
4420
+ export type $201 = Components.Schemas.AutomationExecution;
4421
+ export type $403 = /**
4422
+ * example:
4423
+ * {
4424
+ * "status": 403,
4425
+ * "error": "Forbidden"
4426
+ * }
4427
+ */
4428
+ Components.Responses.ForbiddenError;
4429
+ }
4430
+ }
4431
+ }
4432
+
4433
+
4434
+ interface OperationMethods {
4435
+ /**
4436
+ * searchFlows - searchFlows
4437
+ *
4438
+ * Search available automation flows
4439
+ */
4440
+ 'searchFlows'(
4441
+ parameters?: Parameters<Paths.SearchFlows.QueryParameters> | null,
4442
+ data?: any,
4443
+ config?: AxiosRequestConfig
4444
+ ): OperationResponse<Paths.SearchFlows.Responses.$200>
4445
+ /**
4446
+ * createFlow - createFlow
4447
+ *
4448
+ * Create new automation flow
4449
+ */
4450
+ 'createFlow'(
4451
+ parameters?: Parameters<UnknownParamsObject> | null,
4452
+ data?: Paths.CreateFlow.RequestBody,
4453
+ config?: AxiosRequestConfig
4454
+ ): OperationResponse<Paths.CreateFlow.Responses.$201>
4455
+ /**
4456
+ * batchGetFlows - batchGetFlows
4457
+ *
4458
+ * Get multiple automation flows by their IDs
4459
+ */
4460
+ 'batchGetFlows'(
4461
+ parameters?: Parameters<UnknownParamsObject> | null,
4462
+ data?: Paths.BatchGetFlows.RequestBody,
4463
+ config?: AxiosRequestConfig
4464
+ ): OperationResponse<Paths.BatchGetFlows.Responses.$200>
4465
+ /**
4466
+ * getFlow - getFlow
4467
+ *
4468
+ * List available automation flows
4469
+ */
4470
+ 'getFlow'(
4471
+ parameters?: Parameters<Paths.GetFlow.PathParameters> | null,
4472
+ data?: any,
4473
+ config?: AxiosRequestConfig
4474
+ ): OperationResponse<Paths.GetFlow.Responses.$200>
4475
+ /**
4476
+ * putFlow - putFlow
4477
+ *
4478
+ * Update automation flow by id
4479
+ */
4480
+ 'putFlow'(
4481
+ parameters?: Parameters<Paths.PutFlow.PathParameters> | null,
4482
+ data?: Paths.PutFlow.RequestBody,
4483
+ config?: AxiosRequestConfig
4484
+ ): OperationResponse<Paths.PutFlow.Responses.$200>
4485
+ /**
4486
+ * deleteFlow - deleteFlow
4487
+ *
4488
+ * Update automation flow by id
4489
+ */
4490
+ 'deleteFlow'(
4491
+ parameters?: Parameters<Paths.DeleteFlow.PathParameters> | null,
4492
+ data?: any,
4493
+ config?: AxiosRequestConfig
4494
+ ): OperationResponse<Paths.DeleteFlow.Responses.$200>
4495
+ /**
4496
+ * getExecutions - getExecutions
4497
+ *
4498
+ * List automation executions
4499
+ */
4500
+ 'getExecutions'(
4501
+ parameters?: Parameters<Paths.GetExecutions.QueryParameters> | null,
4502
+ data?: any,
4503
+ config?: AxiosRequestConfig
4504
+ ): OperationResponse<Paths.GetExecutions.Responses.$200>
4505
+ /**
4506
+ * startExecution - startExecution
4507
+ *
4508
+ * Start new automation execution
4509
+ */
4510
+ 'startExecution'(
4511
+ parameters?: Parameters<UnknownParamsObject> | null,
4512
+ data?: Paths.StartExecution.RequestBody,
4513
+ config?: AxiosRequestConfig
4514
+ ): OperationResponse<Paths.StartExecution.Responses.$201>
4515
+ /**
4516
+ * bulkTriggerExecutions - bulkTriggerExecutions
4517
+ *
4518
+ * Create a bulk job that triggers multiple automation executions
4519
+ */
4520
+ 'bulkTriggerExecutions'(
4521
+ parameters?: Parameters<UnknownParamsObject> | null,
4522
+ data?: Paths.BulkTriggerExecutions.RequestBody,
4523
+ config?: AxiosRequestConfig
4524
+ ): OperationResponse<Paths.BulkTriggerExecutions.Responses.$202>
4525
+ /**
4526
+ * getBulkJob - getBulkJob
4527
+ *
4528
+ * Get the status of a bulk job that triggers multiple automation executions
4529
+ */
4530
+ 'getBulkJob'(
4531
+ parameters?: Parameters<Paths.GetBulkJob.PathParameters> | null,
4532
+ data?: any,
4533
+ config?: AxiosRequestConfig
4534
+ ): OperationResponse<Paths.GetBulkJob.Responses.$200>
4535
+ /**
4536
+ * patchBulkJob - patchBulkJob
4537
+ *
4538
+ * Approve / Cancel bulk job that triggers multiple automation executions
4539
+ */
4540
+ 'patchBulkJob'(
4541
+ parameters?: Parameters<Paths.PatchBulkJob.PathParameters> | null,
4542
+ data?: Paths.PatchBulkJob.RequestBody,
4543
+ config?: AxiosRequestConfig
4544
+ ): OperationResponse<Paths.PatchBulkJob.Responses.$200>
4545
+ /**
4546
+ * getExecution - getExecution
4547
+ *
4548
+ * Get automation execution
4549
+ */
4550
+ 'getExecution'(
4551
+ parameters?: Parameters<Paths.GetExecution.PathParameters> | null,
4552
+ data?: any,
4553
+ config?: AxiosRequestConfig
4554
+ ): OperationResponse<Paths.GetExecution.Responses.$200>
4555
+ /**
4556
+ * cancelExecution - cancelExecution
4557
+ *
4558
+ * Cancel automation execution
4559
+ */
4560
+ 'cancelExecution'(
4561
+ parameters?: Parameters<Paths.CancelExecution.PathParameters> | null,
4562
+ data?: any,
4563
+ config?: AxiosRequestConfig
4564
+ ): OperationResponse<Paths.CancelExecution.Responses.$200>
4565
+ /**
4566
+ * retriggerAction - retriggerAction
4567
+ *
4568
+ * Retry a specific automation execution action which failed / is stuck.
4569
+ */
4570
+ 'retriggerAction'(
4571
+ parameters?: Parameters<Paths.RetriggerAction.PathParameters> | null,
4572
+ data?: Paths.RetriggerAction.RequestBody,
4573
+ config?: AxiosRequestConfig
4574
+ ): OperationResponse<Paths.RetriggerAction.Responses.$200>
4575
+ /**
4576
+ * resumeExecutionWithToken - resumeExecutionWithToken
4577
+ *
4578
+ * Resume a paused automation execution using a unique resume token.
4579
+ *
4580
+ * This public API is normally called when a user lands on a confirmation page via email link.
4581
+ *
4582
+ * Example link: https://automation.epilot.io/confirm-email?token=eyJraWQiOiJrZXkifQ...
4583
+ *
4584
+ */
4585
+ 'resumeExecutionWithToken'(
4586
+ parameters?: Parameters<UnknownParamsObject> | null,
4587
+ data?: Paths.ResumeExecutionWithToken.RequestBody,
4588
+ config?: AxiosRequestConfig
4589
+ ): OperationResponse<Paths.ResumeExecutionWithToken.Responses.$200>
4590
+ /**
4591
+ * cancelSchedule - cancelSchedule
4592
+ *
4593
+ * Cancel a scheduled automation
4594
+ */
4595
+ 'cancelSchedule'(
4596
+ parameters?: Parameters<Paths.CancelSchedule.PathParameters> | null,
4597
+ data?: any,
4598
+ config?: AxiosRequestConfig
4599
+ ): OperationResponse<Paths.CancelSchedule.Responses.$200>
4600
+ }
4601
+
4602
+ interface PathsDictionary {
4603
+ ['/v1/automation/flows']: {
4604
+ /**
4605
+ * searchFlows - searchFlows
4606
+ *
4607
+ * Search available automation flows
4608
+ */
4609
+ 'get'(
4610
+ parameters?: Parameters<Paths.SearchFlows.QueryParameters> | null,
4611
+ data?: any,
4612
+ config?: AxiosRequestConfig
4613
+ ): OperationResponse<Paths.SearchFlows.Responses.$200>
4614
+ /**
4615
+ * createFlow - createFlow
4616
+ *
4617
+ * Create new automation flow
4618
+ */
4619
+ 'post'(
4620
+ parameters?: Parameters<UnknownParamsObject> | null,
4621
+ data?: Paths.CreateFlow.RequestBody,
4622
+ config?: AxiosRequestConfig
4623
+ ): OperationResponse<Paths.CreateFlow.Responses.$201>
4624
+ }
4625
+ ['/v1/automation/flows:batchGet']: {
4626
+ /**
4627
+ * batchGetFlows - batchGetFlows
4628
+ *
4629
+ * Get multiple automation flows by their IDs
4630
+ */
4631
+ 'post'(
4632
+ parameters?: Parameters<UnknownParamsObject> | null,
4633
+ data?: Paths.BatchGetFlows.RequestBody,
4634
+ config?: AxiosRequestConfig
4635
+ ): OperationResponse<Paths.BatchGetFlows.Responses.$200>
4636
+ }
4637
+ ['/v1/automation/flows/{flow_id}']: {
4638
+ /**
4639
+ * getFlow - getFlow
4640
+ *
4641
+ * List available automation flows
4642
+ */
4643
+ 'get'(
4644
+ parameters?: Parameters<Paths.GetFlow.PathParameters> | null,
4645
+ data?: any,
4646
+ config?: AxiosRequestConfig
4647
+ ): OperationResponse<Paths.GetFlow.Responses.$200>
4648
+ /**
4649
+ * putFlow - putFlow
4650
+ *
4651
+ * Update automation flow by id
4652
+ */
4653
+ 'put'(
4654
+ parameters?: Parameters<Paths.PutFlow.PathParameters> | null,
4655
+ data?: Paths.PutFlow.RequestBody,
4656
+ config?: AxiosRequestConfig
4657
+ ): OperationResponse<Paths.PutFlow.Responses.$200>
4658
+ /**
4659
+ * deleteFlow - deleteFlow
4660
+ *
4661
+ * Update automation flow by id
4662
+ */
4663
+ 'delete'(
4664
+ parameters?: Parameters<Paths.DeleteFlow.PathParameters> | null,
4665
+ data?: any,
4666
+ config?: AxiosRequestConfig
4667
+ ): OperationResponse<Paths.DeleteFlow.Responses.$200>
4668
+ }
4669
+ ['/v1/automation/executions']: {
4670
+ /**
4671
+ * getExecutions - getExecutions
4672
+ *
4673
+ * List automation executions
4674
+ */
4675
+ 'get'(
4676
+ parameters?: Parameters<Paths.GetExecutions.QueryParameters> | null,
4677
+ data?: any,
4678
+ config?: AxiosRequestConfig
4679
+ ): OperationResponse<Paths.GetExecutions.Responses.$200>
4680
+ /**
4681
+ * startExecution - startExecution
4682
+ *
4683
+ * Start new automation execution
4684
+ */
4685
+ 'post'(
4686
+ parameters?: Parameters<UnknownParamsObject> | null,
4687
+ data?: Paths.StartExecution.RequestBody,
4688
+ config?: AxiosRequestConfig
4689
+ ): OperationResponse<Paths.StartExecution.Responses.$201>
4690
+ }
4691
+ ['/v1/automation/executions/bulk-jobs']: {
4692
+ /**
4693
+ * bulkTriggerExecutions - bulkTriggerExecutions
4694
+ *
4695
+ * Create a bulk job that triggers multiple automation executions
4696
+ */
4697
+ 'post'(
4698
+ parameters?: Parameters<UnknownParamsObject> | null,
4699
+ data?: Paths.BulkTriggerExecutions.RequestBody,
4700
+ config?: AxiosRequestConfig
4701
+ ): OperationResponse<Paths.BulkTriggerExecutions.Responses.$202>
4702
+ }
4703
+ ['/v1/automation/executions/bulk-jobs/{job_id}']: {
4704
+ /**
4705
+ * getBulkJob - getBulkJob
4706
+ *
4707
+ * Get the status of a bulk job that triggers multiple automation executions
4708
+ */
4709
+ 'get'(
4710
+ parameters?: Parameters<Paths.GetBulkJob.PathParameters> | null,
4711
+ data?: any,
4712
+ config?: AxiosRequestConfig
4713
+ ): OperationResponse<Paths.GetBulkJob.Responses.$200>
4714
+ /**
4715
+ * patchBulkJob - patchBulkJob
4716
+ *
4717
+ * Approve / Cancel bulk job that triggers multiple automation executions
4718
+ */
4719
+ 'patch'(
4720
+ parameters?: Parameters<Paths.PatchBulkJob.PathParameters> | null,
4721
+ data?: Paths.PatchBulkJob.RequestBody,
4722
+ config?: AxiosRequestConfig
4723
+ ): OperationResponse<Paths.PatchBulkJob.Responses.$200>
4724
+ }
4725
+ ['/v1/automation/executions/{execution_id}']: {
4726
+ /**
4727
+ * getExecution - getExecution
4728
+ *
4729
+ * Get automation execution
4730
+ */
4731
+ 'get'(
4732
+ parameters?: Parameters<Paths.GetExecution.PathParameters> | null,
4733
+ data?: any,
4734
+ config?: AxiosRequestConfig
4735
+ ): OperationResponse<Paths.GetExecution.Responses.$200>
4736
+ /**
4737
+ * cancelExecution - cancelExecution
4738
+ *
4739
+ * Cancel automation execution
4740
+ */
4741
+ 'delete'(
4742
+ parameters?: Parameters<Paths.CancelExecution.PathParameters> | null,
4743
+ data?: any,
4744
+ config?: AxiosRequestConfig
4745
+ ): OperationResponse<Paths.CancelExecution.Responses.$200>
4746
+ }
4747
+ ['/v1/automation/executions/{execution_id}/{action_id}/retrigger']: {
4748
+ /**
4749
+ * retriggerAction - retriggerAction
4750
+ *
4751
+ * Retry a specific automation execution action which failed / is stuck.
4752
+ */
4753
+ 'post'(
4754
+ parameters?: Parameters<Paths.RetriggerAction.PathParameters> | null,
4755
+ data?: Paths.RetriggerAction.RequestBody,
4756
+ config?: AxiosRequestConfig
4757
+ ): OperationResponse<Paths.RetriggerAction.Responses.$200>
4758
+ }
4759
+ ['/v1/automation/public/executions:resume']: {
4760
+ /**
4761
+ * resumeExecutionWithToken - resumeExecutionWithToken
4762
+ *
4763
+ * Resume a paused automation execution using a unique resume token.
4764
+ *
4765
+ * This public API is normally called when a user lands on a confirmation page via email link.
4766
+ *
4767
+ * Example link: https://automation.epilot.io/confirm-email?token=eyJraWQiOiJrZXkifQ...
4768
+ *
4769
+ */
4770
+ 'post'(
4771
+ parameters?: Parameters<UnknownParamsObject> | null,
4772
+ data?: Paths.ResumeExecutionWithToken.RequestBody,
4773
+ config?: AxiosRequestConfig
4774
+ ): OperationResponse<Paths.ResumeExecutionWithToken.Responses.$200>
4775
+ }
4776
+ ['/v1/automation/executions/{execution_id}/schedules/{schedule_id}']: {
4777
+ /**
4778
+ * cancelSchedule - cancelSchedule
4779
+ *
4780
+ * Cancel a scheduled automation
4781
+ */
4782
+ 'delete'(
4783
+ parameters?: Parameters<Paths.CancelSchedule.PathParameters> | null,
4784
+ data?: any,
4785
+ config?: AxiosRequestConfig
4786
+ ): OperationResponse<Paths.CancelSchedule.Responses.$200>
4787
+ }
4788
+ }
4789
+
4790
+ type Client = OpenAPIClient<OperationMethods, PathsDictionary>
4791
+
4792
+
4793
+ type ActionCondition = Components.Schemas.ActionCondition;
4794
+ type ActionSchedule = Components.Schemas.ActionSchedule;
4795
+ type ActionScheduleSource = Components.Schemas.ActionScheduleSource;
4796
+ type ActivityId = Components.Schemas.ActivityId;
4797
+ type ActivityTrigger = Components.Schemas.ActivityTrigger;
4798
+ type AnyAction = Components.Schemas.AnyAction;
4799
+ type AnyActionConfig = Components.Schemas.AnyActionConfig;
4800
+ type AnyTrigger = Components.Schemas.AnyTrigger;
4801
+ type AnythingButCondition = Components.Schemas.AnythingButCondition;
4802
+ type ApiCallerContext = Components.Schemas.ApiCallerContext;
4803
+ type ApiSubmissionTrigger = Components.Schemas.ApiSubmissionTrigger;
4804
+ type AppendValueMapper = Components.Schemas.AppendValueMapper;
4805
+ type AssignThreadAction = Components.Schemas.AssignThreadAction;
4806
+ type AssignThreadConfig = Components.Schemas.AssignThreadConfig;
4807
+ type AssignUsersToStep = Components.Schemas.AssignUsersToStep;
4808
+ type AutomationAction = Components.Schemas.AutomationAction;
4809
+ type AutomationActionConfig = Components.Schemas.AutomationActionConfig;
4810
+ type AutomationActionExecutionState = Components.Schemas.AutomationActionExecutionState;
4811
+ type AutomationActionId = Components.Schemas.AutomationActionId;
4812
+ type AutomationExecution = Components.Schemas.AutomationExecution;
4813
+ type AutomationExecutionId = Components.Schemas.AutomationExecutionId;
4814
+ type AutomationFlow = Components.Schemas.AutomationFlow;
4815
+ type AutomationFlowId = Components.Schemas.AutomationFlowId;
4816
+ type AutomationTrigger = Components.Schemas.AutomationTrigger;
4817
+ type BulkTriggerJob = Components.Schemas.BulkTriggerJob;
4818
+ type BulkTriggerRequest = Components.Schemas.BulkTriggerRequest;
4819
+ type CancellationReason = Components.Schemas.CancellationReason;
4820
+ type CartCheckoutAction = Components.Schemas.CartCheckoutAction;
4821
+ type CartCheckoutActionConfig = Components.Schemas.CartCheckoutActionConfig;
4822
+ type CartCheckoutConfig = Components.Schemas.CartCheckoutConfig;
4823
+ type Comparison = Components.Schemas.Comparison;
4824
+ type ConditionStatement = Components.Schemas.ConditionStatement;
4825
+ type CopyValueMapper = Components.Schemas.CopyValueMapper;
4826
+ type CreateDocumentAction = Components.Schemas.CreateDocumentAction;
4827
+ type CreateDocumentActionConfig = Components.Schemas.CreateDocumentActionConfig;
4828
+ type CreateDocumentConfig = Components.Schemas.CreateDocumentConfig;
4829
+ type CustomAction = Components.Schemas.CustomAction;
4830
+ type DiffAdded = Components.Schemas.DiffAdded;
4831
+ type DiffDeleted = Components.Schemas.DiffDeleted;
4832
+ type DiffUpdated = Components.Schemas.DiffUpdated;
4833
+ type EntityId = Components.Schemas.EntityId;
4834
+ type EntityItemSnapshot = Components.Schemas.EntityItemSnapshot;
4835
+ type EntityManualTrigger = Components.Schemas.EntityManualTrigger;
4836
+ type EntityOperation = Components.Schemas.EntityOperation;
4837
+ type EntityOperationTrigger = Components.Schemas.EntityOperationTrigger;
4838
+ type EntityRef = Components.Schemas.EntityRef;
4839
+ type EntitySearchFilter = Components.Schemas.EntitySearchFilter;
4840
+ type EntitySearchFilterValue = Components.Schemas.EntitySearchFilterValue;
4841
+ type EqualsIgnoreCaseCondition = Components.Schemas.EqualsIgnoreCaseCondition;
4842
+ type ErrorCode = Components.Schemas.ErrorCode;
4843
+ type ErrorDetail = Components.Schemas.ErrorDetail;
4844
+ type ErrorObject = Components.Schemas.ErrorObject;
4845
+ type ErrorOutput = Components.Schemas.ErrorOutput;
4846
+ type ExecItem = Components.Schemas.ExecItem;
4847
+ type ExecutionChain = Components.Schemas.ExecutionChain;
4848
+ type ExecutionStatus = Components.Schemas.ExecutionStatus;
4849
+ type ExistsCondition = Components.Schemas.ExistsCondition;
4850
+ type FilterConditionOnEvent = Components.Schemas.FilterConditionOnEvent;
4851
+ type FlowExecutionCancelAction = Components.Schemas.FlowExecutionCancelAction;
4852
+ type FlowExecutionCancelActionConfig = Components.Schemas.FlowExecutionCancelActionConfig;
4853
+ type FlowExecutionCancelConfig = Components.Schemas.FlowExecutionCancelConfig;
4854
+ type FlowsTrigger = Components.Schemas.FlowsTrigger;
4855
+ type FrontendSubmitTrigger = Components.Schemas.FrontendSubmitTrigger;
4856
+ type GetExecutionsResp = Components.Schemas.GetExecutionsResp;
4857
+ type InformERPAction = Components.Schemas.InformERPAction;
4858
+ type InformERPActionConfig = Components.Schemas.InformERPActionConfig;
4859
+ type InformERPConfig = Components.Schemas.InformERPConfig;
4860
+ type JobId = Components.Schemas.JobId;
4861
+ type JourneySubmitTrigger = Components.Schemas.JourneySubmitTrigger;
4862
+ type MapEntityAction = Components.Schemas.MapEntityAction;
4863
+ type MapEntityActionConfig = Components.Schemas.MapEntityActionConfig;
4864
+ type MapEntityConfig = Components.Schemas.MapEntityConfig;
4865
+ type MappingAttribute = Components.Schemas.MappingAttribute;
4866
+ type MappingAttributeMode = Components.Schemas.MappingAttributeMode;
4867
+ type MappingAttributeV2 = Components.Schemas.MappingAttributeV2;
4868
+ type MappingConfigRef = Components.Schemas.MappingConfigRef;
4869
+ type MoveThreadAction = Components.Schemas.MoveThreadAction;
4870
+ type MoveThreadConfig = Components.Schemas.MoveThreadConfig;
4871
+ type NewEmailThreadTrigger = Components.Schemas.NewEmailThreadTrigger;
4872
+ type NumericCondition = Components.Schemas.NumericCondition;
4873
+ type OperationNode = Components.Schemas.OperationNode;
4874
+ type OperationObjectNode = Components.Schemas.OperationObjectNode;
4875
+ type OrCondition = Components.Schemas.OrCondition;
4876
+ type OrConditionForDiff = Components.Schemas.OrConditionForDiff;
4877
+ type OrganizationId = Components.Schemas.OrganizationId;
4878
+ type PatchBulkJobRequest = Components.Schemas.PatchBulkJobRequest;
4879
+ type PrefixCondition = Components.Schemas.PrefixCondition;
4880
+ type PrimitiveJSONValue = Components.Schemas.PrimitiveJSONValue;
4881
+ type ReceivedEmailTrigger = Components.Schemas.ReceivedEmailTrigger;
4882
+ type RelationAttribute = Components.Schemas.RelationAttribute;
4883
+ type ResumeReq = Components.Schemas.ResumeReq;
4884
+ type ResumeResp = Components.Schemas.ResumeResp;
4885
+ type ResumeToken = Components.Schemas.ResumeToken;
4886
+ type RetryReq = Components.Schemas.RetryReq;
4887
+ type RetryStrategy = Components.Schemas.RetryStrategy;
4888
+ type SearchAutomationsResp = Components.Schemas.SearchAutomationsResp;
4889
+ type SendEmailAction = Components.Schemas.SendEmailAction;
4890
+ type SendEmailActionConfig = Components.Schemas.SendEmailActionConfig;
4891
+ type SendEmailCondition = Components.Schemas.SendEmailCondition;
4892
+ type SendEmailConfig = Components.Schemas.SendEmailConfig;
4893
+ type SetValueMapper = Components.Schemas.SetValueMapper;
4894
+ type StartExecutionRequest = Components.Schemas.StartExecutionRequest;
4895
+ type SuffixCondition = Components.Schemas.SuffixCondition;
4896
+ type TriggerCondition = Components.Schemas.TriggerCondition;
4897
+ type TriggerContext = Components.Schemas.TriggerContext;
4898
+ type TriggerEventAction = Components.Schemas.TriggerEventAction;
4899
+ type TriggerEventActionConfig = Components.Schemas.TriggerEventActionConfig;
4900
+ type TriggerEventConfig = Components.Schemas.TriggerEventConfig;
4901
+ type TriggerEventEntityActivity = Components.Schemas.TriggerEventEntityActivity;
4902
+ type TriggerEventEntityOperation = Components.Schemas.TriggerEventEntityOperation;
4903
+ type TriggerEventFlowAutomationTask = Components.Schemas.TriggerEventFlowAutomationTask;
4904
+ type TriggerEventManual = Components.Schemas.TriggerEventManual;
4905
+ type TriggerEventMessaging = Components.Schemas.TriggerEventMessaging;
4906
+ type TriggerShareEntityAction = Components.Schemas.TriggerShareEntityAction;
4907
+ type TriggerShareEntityActionConfig = Components.Schemas.TriggerShareEntityActionConfig;
4908
+ type TriggerShareEntityConfig = Components.Schemas.TriggerShareEntityConfig;
4909
+ type TriggerWebhookAction = Components.Schemas.TriggerWebhookAction;
4910
+ type TriggerWebhookActionConfig = Components.Schemas.TriggerWebhookActionConfig;
4911
+ type TriggerWebhookConfig = Components.Schemas.TriggerWebhookConfig;
4912
+ type TriggerWorkflowAction = Components.Schemas.TriggerWorkflowAction;
4913
+ type TriggerWorkflowActionConfig = Components.Schemas.TriggerWorkflowActionConfig;
4914
+ type TriggerWorkflowCondition = Components.Schemas.TriggerWorkflowCondition;
4915
+ type TriggerWorkflowConfig = Components.Schemas.TriggerWorkflowConfig;
4916
+ type WildcardCondition = Components.Schemas.WildcardCondition;
4917
+ type WorkflowContext = Components.Schemas.WorkflowContext;
4918
+ type WorkflowContextRole = Components.Schemas.WorkflowContextRole;
4919
+ type WorkflowExecutionContext = Components.Schemas.WorkflowExecutionContext;
4920
+
4921
+ export type { ErrorDetail as $, ActionCondition as A, BulkTriggerJob as B, Client as C, CartCheckoutActionConfig as D, CartCheckoutConfig as E, Comparison as F, ConditionStatement as G, CopyValueMapper as H, CreateDocumentAction as I, CreateDocumentActionConfig as J, CreateDocumentConfig as K, CustomAction as L, DiffAdded as M, DiffDeleted as N, OperationMethods as O, PathsDictionary as P, DiffUpdated as Q, EntityId as R, EntityItemSnapshot as S, EntityManualTrigger as T, EntityOperation as U, EntityOperationTrigger as V, EntityRef as W, EntitySearchFilter as X, EntitySearchFilterValue as Y, EqualsIgnoreCaseCondition as Z, ErrorCode as _, ActionSchedule as a, TriggerShareEntityActionConfig as a$, ErrorObject as a0, ErrorOutput as a1, ExecItem as a2, ExecutionChain as a3, ExecutionStatus as a4, ExistsCondition as a5, FilterConditionOnEvent as a6, FlowExecutionCancelAction as a7, FlowExecutionCancelActionConfig as a8, FlowExecutionCancelConfig as a9, PrimitiveJSONValue as aA, ReceivedEmailTrigger as aB, RelationAttribute as aC, ResumeReq as aD, ResumeResp as aE, ResumeToken as aF, RetryReq as aG, RetryStrategy as aH, SearchAutomationsResp as aI, SendEmailAction as aJ, SendEmailActionConfig as aK, SendEmailCondition as aL, SendEmailConfig as aM, SetValueMapper as aN, StartExecutionRequest as aO, SuffixCondition as aP, TriggerCondition as aQ, TriggerContext as aR, TriggerEventAction as aS, TriggerEventActionConfig as aT, TriggerEventConfig as aU, TriggerEventEntityActivity as aV, TriggerEventEntityOperation as aW, TriggerEventFlowAutomationTask as aX, TriggerEventManual as aY, TriggerEventMessaging as aZ, TriggerShareEntityAction as a_, FlowsTrigger as aa, FrontendSubmitTrigger as ab, GetExecutionsResp as ac, InformERPAction as ad, InformERPActionConfig as ae, InformERPConfig as af, JobId as ag, JourneySubmitTrigger as ah, MapEntityAction as ai, MapEntityActionConfig as aj, MapEntityConfig as ak, MappingAttribute as al, MappingAttributeMode as am, MappingAttributeV2 as an, MappingConfigRef as ao, MoveThreadAction as ap, MoveThreadConfig as aq, NewEmailThreadTrigger as ar, NumericCondition as as, OperationNode as at, OperationObjectNode as au, OrCondition as av, OrConditionForDiff as aw, OrganizationId as ax, PatchBulkJobRequest as ay, PrefixCondition as az, ActionScheduleSource as b, TriggerShareEntityConfig as b0, TriggerWebhookAction as b1, TriggerWebhookActionConfig as b2, TriggerWebhookConfig as b3, TriggerWorkflowAction as b4, TriggerWorkflowActionConfig as b5, TriggerWorkflowCondition as b6, TriggerWorkflowConfig as b7, WildcardCondition as b8, WorkflowContext as b9, WorkflowContextRole as ba, WorkflowExecutionContext as bb, ActivityId as c, ActivityTrigger as d, AnyAction as e, AnyActionConfig as f, AnyTrigger as g, AnythingButCondition as h, ApiCallerContext as i, ApiSubmissionTrigger as j, AppendValueMapper as k, AssignThreadAction as l, AssignThreadConfig as m, AssignUsersToStep as n, AutomationAction as o, AutomationActionConfig as p, AutomationActionExecutionState as q, AutomationActionId as r, AutomationExecution as s, AutomationExecutionId as t, AutomationFlow as u, AutomationFlowId as v, AutomationTrigger as w, BulkTriggerRequest as x, CancellationReason as y, CartCheckoutAction as z };