@epilot/sdk 2.1.0-rc.1 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (359) hide show
  1. package/definitions/app.json +38 -0
  2. package/definitions/automation.json +2 -37
  3. package/definitions/blueprint-manifest-runtime.json +1 -1
  4. package/definitions/blueprint-manifest.json +115 -1
  5. package/definitions/customer-portal-runtime.json +1 -1
  6. package/definitions/customer-portal.json +279 -42
  7. package/definitions/data-management.json +10 -0
  8. package/definitions/email-template.json +25 -3
  9. package/definitions/entity.json +205 -3
  10. package/definitions/erp-integration-runtime.json +1 -1
  11. package/definitions/erp-integration.json +472 -13
  12. package/definitions/journey.json +257 -12
  13. package/definitions/kanban.json +630 -78
  14. package/definitions/organization-runtime.json +1 -1
  15. package/definitions/organization.json +614 -51
  16. package/definitions/workflow.json +40 -0
  17. package/dist/README-VG67PX4R.js +7 -0
  18. package/dist/README-W4B35MRN.cjs +7 -0
  19. package/dist/_index-AMVZBT2K.cjs +99 -0
  20. package/dist/_index-S6LFD3ER.js +99 -0
  21. package/dist/access-token-6BJDZSFE.cjs +7 -0
  22. package/dist/access-token-GSQZLDXR.js +7 -0
  23. package/dist/address-HA4RMRNQ.cjs +7 -0
  24. package/dist/address-QVJUGMOG.js +7 -0
  25. package/dist/address-suggestions-74244BAJ.js +7 -0
  26. package/dist/address-suggestions-IUQMYF27.cjs +7 -0
  27. package/dist/ai-agents-IZWFEUSH.js +7 -0
  28. package/dist/ai-agents-PWHKNRCX.cjs +7 -0
  29. package/dist/apis/access-token.cjs +10 -8
  30. package/dist/apis/access-token.js +5 -3
  31. package/dist/apis/address-suggestions.cjs +10 -8
  32. package/dist/apis/address-suggestions.js +5 -3
  33. package/dist/apis/address.cjs +10 -8
  34. package/dist/apis/address.js +5 -3
  35. package/dist/apis/ai-agents.cjs +10 -8
  36. package/dist/apis/ai-agents.js +5 -3
  37. package/dist/apis/app.cjs +10 -8
  38. package/dist/apis/app.js +5 -3
  39. package/dist/apis/audit-logs.cjs +10 -8
  40. package/dist/apis/audit-logs.js +5 -3
  41. package/dist/apis/automation.cjs +10 -8
  42. package/dist/apis/automation.js +5 -3
  43. package/dist/apis/billing.cjs +10 -8
  44. package/dist/apis/billing.js +5 -3
  45. package/dist/apis/blueprint-manifest.cjs +10 -8
  46. package/dist/apis/blueprint-manifest.js +5 -3
  47. package/dist/apis/consent.cjs +10 -8
  48. package/dist/apis/consent.js +5 -3
  49. package/dist/apis/customer-portal.cjs +10 -8
  50. package/dist/apis/customer-portal.js +5 -3
  51. package/dist/apis/dashboard.cjs +10 -8
  52. package/dist/apis/dashboard.js +5 -3
  53. package/dist/apis/data-management.cjs +10 -8
  54. package/dist/apis/data-management.js +5 -3
  55. package/dist/apis/deduplication.cjs +10 -8
  56. package/dist/apis/deduplication.js +5 -3
  57. package/dist/apis/design.cjs +10 -8
  58. package/dist/apis/design.js +5 -3
  59. package/dist/apis/document.cjs +10 -8
  60. package/dist/apis/document.js +5 -3
  61. package/dist/apis/email-settings.cjs +10 -8
  62. package/dist/apis/email-settings.js +5 -3
  63. package/dist/apis/email-template.cjs +10 -8
  64. package/dist/apis/email-template.js +5 -3
  65. package/dist/apis/entity-mapping.cjs +10 -8
  66. package/dist/apis/entity-mapping.js +5 -3
  67. package/dist/apis/entity.cjs +10 -8
  68. package/dist/apis/entity.js +5 -3
  69. package/dist/apis/environments.cjs +10 -8
  70. package/dist/apis/environments.js +5 -3
  71. package/dist/apis/erp-integration.cjs +10 -8
  72. package/dist/apis/erp-integration.js +5 -3
  73. package/dist/apis/event-catalog.cjs +10 -8
  74. package/dist/apis/event-catalog.js +5 -3
  75. package/dist/apis/file.cjs +10 -8
  76. package/dist/apis/file.js +5 -3
  77. package/dist/apis/iban.cjs +10 -8
  78. package/dist/apis/iban.js +5 -3
  79. package/dist/apis/journey.cjs +10 -8
  80. package/dist/apis/journey.js +5 -3
  81. package/dist/apis/kanban.cjs +10 -8
  82. package/dist/apis/kanban.js +5 -3
  83. package/dist/apis/message.cjs +10 -8
  84. package/dist/apis/message.js +5 -3
  85. package/dist/apis/metering.cjs +10 -8
  86. package/dist/apis/metering.js +5 -3
  87. package/dist/apis/notes.cjs +10 -8
  88. package/dist/apis/notes.js +5 -3
  89. package/dist/apis/notification.cjs +10 -8
  90. package/dist/apis/notification.js +5 -3
  91. package/dist/apis/organization.cjs +10 -8
  92. package/dist/apis/organization.d.cts +2 -2
  93. package/dist/apis/organization.d.ts +2 -2
  94. package/dist/apis/organization.js +5 -3
  95. package/dist/apis/partner-directory.cjs +10 -8
  96. package/dist/apis/partner-directory.js +5 -3
  97. package/dist/apis/permissions.cjs +10 -8
  98. package/dist/apis/permissions.js +5 -3
  99. package/dist/apis/pricing-tier.cjs +10 -8
  100. package/dist/apis/pricing-tier.js +5 -3
  101. package/dist/apis/pricing.cjs +10 -8
  102. package/dist/apis/pricing.js +5 -3
  103. package/dist/apis/purpose.cjs +10 -8
  104. package/dist/apis/purpose.js +5 -3
  105. package/dist/apis/sandbox.cjs +10 -8
  106. package/dist/apis/sandbox.js +5 -3
  107. package/dist/apis/submission.cjs +10 -8
  108. package/dist/apis/submission.js +5 -3
  109. package/dist/apis/targeting.cjs +10 -8
  110. package/dist/apis/targeting.js +5 -3
  111. package/dist/apis/template-variables.cjs +10 -8
  112. package/dist/apis/template-variables.js +5 -3
  113. package/dist/apis/user.cjs +10 -8
  114. package/dist/apis/user.js +5 -3
  115. package/dist/apis/validation-rules.cjs +10 -8
  116. package/dist/apis/validation-rules.js +5 -3
  117. package/dist/apis/webhooks.cjs +10 -8
  118. package/dist/apis/webhooks.js +5 -3
  119. package/dist/apis/workflow-definition.cjs +10 -8
  120. package/dist/apis/workflow-definition.js +5 -3
  121. package/dist/apis/workflow.cjs +10 -8
  122. package/dist/apis/workflow.js +5 -3
  123. package/dist/app-IKHWU222.cjs +7 -0
  124. package/dist/app-VLM3SWKA.js +7 -0
  125. package/dist/audit-logs-5VXHOQ7S.js +7 -0
  126. package/dist/audit-logs-D2LFUA2R.cjs +7 -0
  127. package/dist/automation-3HGCK725.cjs +7 -0
  128. package/dist/automation-72VGEJCY.js +7 -0
  129. package/dist/billing-DUWDISHP.cjs +7 -0
  130. package/dist/billing-IPALEAG2.js +7 -0
  131. package/dist/blueprint-manifest-CXSCRQ5X.js +7 -0
  132. package/dist/blueprint-manifest-SHNZPK5O.cjs +7 -0
  133. package/dist/{chunk-6J7CIOKR.js → chunk-2HOJWFQ4.js} +1 -1
  134. package/dist/{chunk-BDIJHJOG.js → chunk-372VUPHN.js} +1 -1
  135. package/dist/{chunk-Q5TESEDZ.cjs → chunk-3HJEWWPS.cjs} +2 -2
  136. package/dist/{chunk-ID6BXIOZ.js → chunk-3N67SSL3.js} +1 -1
  137. package/dist/chunk-3XEP56SV.cjs +204 -0
  138. package/dist/{chunk-7KFKA3AH.cjs → chunk-3ZZ57K3S.cjs} +2 -2
  139. package/dist/{chunk-CVSQT5PV.cjs → chunk-4SWC43JO.cjs} +2 -2
  140. package/dist/{chunk-O3R6C3WW.js → chunk-4VFQTSJQ.js} +1 -1
  141. package/dist/{chunk-LXAJ722U.js → chunk-57QIBYDN.js} +1 -1
  142. package/dist/{chunk-SPZSDRM6.cjs → chunk-5SNJAD6F.cjs} +2 -2
  143. package/dist/{chunk-OI2M6FSB.js → chunk-73H6TVKN.js} +1 -1
  144. package/dist/{chunk-BB7WFIE2.cjs → chunk-A6JOROUC.cjs} +2 -2
  145. package/dist/{chunk-SHPXCOTN.cjs → chunk-AJKH25H2.cjs} +3 -3
  146. package/dist/{chunk-DBNEZWK2.cjs → chunk-ARWMTXJV.cjs} +2 -2
  147. package/dist/{chunk-7BPPP4M2.js → chunk-B3ZGAG7B.js} +1 -1
  148. package/dist/{chunk-5WN2YXNU.cjs → chunk-BH5ZXK4J.cjs} +2 -2
  149. package/dist/{chunk-JM6HKPSC.cjs → chunk-BWFXLUK5.cjs} +2 -2
  150. package/dist/{chunk-V56ZCL54.js → chunk-C6UTZEHH.js} +1 -1
  151. package/dist/{chunk-ZPCMZO2O.js → chunk-CPKBR34V.js} +1 -1
  152. package/dist/{chunk-UTQY2DSM.js → chunk-CWSHYFVZ.js} +1 -1
  153. package/dist/{chunk-5YVVQBA2.js → chunk-DJKSULPK.js} +1 -1
  154. package/dist/{chunk-XLOXC52O.js → chunk-DNJ54L2G.js} +1 -1
  155. package/dist/{chunk-YXPUCBVK.cjs → chunk-DY2D2IW5.cjs} +2 -2
  156. package/dist/{chunk-Z5LLUUFD.cjs → chunk-E26ZO7QM.cjs} +2 -2
  157. package/dist/{chunk-RNKZDJOY.js → chunk-EBCHCYUO.js} +1 -1
  158. package/dist/{chunk-4MO4WLKA.cjs → chunk-EPAIOB5U.cjs} +2 -2
  159. package/dist/{chunk-UX2IZQNM.cjs → chunk-EQZMT2HF.cjs} +2 -2
  160. package/dist/{chunk-U52A2DMK.cjs → chunk-F376L6PP.cjs} +2 -2
  161. package/dist/{chunk-TBBLLEB2.cjs → chunk-F472YLJG.cjs} +2 -2
  162. package/dist/{chunk-W3MM2BSK.cjs → chunk-FXOX3X7E.cjs} +2 -2
  163. package/dist/{chunk-E4IFBCNM.cjs → chunk-G2REP2VZ.cjs} +2 -2
  164. package/dist/{chunk-CFGXI3FX.js → chunk-GLO477NZ.js} +1 -1
  165. package/dist/{chunk-PBNPZ7UX.js → chunk-H4VSK4KF.js} +1 -1
  166. package/dist/{chunk-33TQRYMY.js → chunk-HPSGM6QP.js} +1 -1
  167. package/dist/{chunk-RQKN4WTW.cjs → chunk-HPYHWTTA.cjs} +2 -2
  168. package/dist/{chunk-5RXE7X63.js → chunk-IH4CMOML.js} +2 -2
  169. package/dist/{chunk-VD5TBK2T.cjs → chunk-IMT3IE5M.cjs} +2 -2
  170. package/dist/{chunk-DIP442PL.js → chunk-IP2WWEOU.js} +1 -1
  171. package/dist/{chunk-FCLW3FLF.js → chunk-IS2VB342.js} +1 -1
  172. package/dist/{chunk-UNHWLNE4.js → chunk-ITX53XAZ.js} +1 -1
  173. package/dist/{chunk-KU2XF4TS.cjs → chunk-JXBXDTFG.cjs} +2 -2
  174. package/dist/{chunk-Y4YQEDR3.js → chunk-K62XK7KU.js} +1 -1
  175. package/dist/chunk-KA3TGFJP.js +14 -0
  176. package/dist/{chunk-IXRDP4VP.js → chunk-KBOVBUBM.js} +1 -1
  177. package/dist/{chunk-MKZGM4A6.js → chunk-KPGC2D6E.js} +1 -1
  178. package/dist/{chunk-ZAPA4RPI.js → chunk-KSXTBGIV.js} +1 -1
  179. package/dist/{chunk-PLBIQ2Y7.cjs → chunk-LCIJ4TJ4.cjs} +2 -2
  180. package/dist/{chunk-TUAAE3UC.cjs → chunk-LQOLYXGQ.cjs} +2 -2
  181. package/dist/{chunk-6ADJEPMJ.js → chunk-LSIWCIQV.js} +1 -1
  182. package/dist/{chunk-CBRWUULQ.js → chunk-MHNSZ4HE.js} +1 -1
  183. package/dist/{chunk-WOOKHE7Y.cjs → chunk-MKX4CKAB.cjs} +2 -2
  184. package/dist/{chunk-N2P26AAD.js → chunk-MRTAFRO7.js} +1 -1
  185. package/dist/{chunk-YGULLD73.js → chunk-MRZ7LGKZ.js} +1 -1
  186. package/dist/{chunk-CLMZ2EXW.js → chunk-MSASBR2Y.js} +1 -1
  187. package/dist/{chunk-KEJRWMXR.cjs → chunk-NAWLLC3T.cjs} +2 -2
  188. package/dist/chunk-NJK5F5TF.cjs +21 -0
  189. package/dist/{chunk-HBPCJRZX.cjs → chunk-NLSZVGHK.cjs} +2 -2
  190. package/dist/{chunk-CK36RZXR.js → chunk-O4LRVGOY.js} +1 -1
  191. package/dist/chunk-OG2DMGU6.cjs +14 -0
  192. package/dist/{chunk-TIJGLQKO.js → chunk-OGQKJTXF.js} +1 -1
  193. package/dist/{chunk-UE4XPL43.js → chunk-PETLAONH.js} +1 -1
  194. package/dist/{chunk-MK4ZGXVE.cjs → chunk-PVSS2WPM.cjs} +2 -2
  195. package/dist/{chunk-ONN5COYQ.cjs → chunk-PXITFTJA.cjs} +2 -2
  196. package/dist/{chunk-ZAXYMQ2B.cjs → chunk-QDVPPRWI.cjs} +2 -2
  197. package/dist/{chunk-IPFHV2FV.cjs → chunk-QKERXNJJ.cjs} +2 -2
  198. package/dist/{chunk-ZDJ3J6Z6.cjs → chunk-QLML3IP5.cjs} +2 -2
  199. package/dist/{chunk-YFHQYQII.js → chunk-QVAJ5JP4.js} +1 -1
  200. package/dist/{chunk-S2QF6HG2.cjs → chunk-RD7E4OSJ.cjs} +2 -2
  201. package/dist/{chunk-XIB2G42L.cjs → chunk-RWSA3LXE.cjs} +2 -2
  202. package/dist/{chunk-R6WNZVTA.cjs → chunk-RXSS67VI.cjs} +2 -2
  203. package/dist/{chunk-UXVV3BSC.cjs → chunk-S3ZNESMC.cjs} +2 -2
  204. package/dist/{chunk-YNPRF4BX.js → chunk-S7NDMDRX.js} +1 -1
  205. package/dist/{chunk-HO7KACZZ.cjs → chunk-SK3VYIZ6.cjs} +2 -2
  206. package/dist/{chunk-CX3KG7D2.cjs → chunk-SMGHAG5C.cjs} +2 -2
  207. package/dist/{chunk-D5FJ26GG.js → chunk-T46LODOF.js} +1 -1
  208. package/dist/{chunk-Y4ZMNMYI.js → chunk-TIJWJVKZ.js} +1 -1
  209. package/dist/{chunk-EIILOQ6X.js → chunk-TLWCYLNA.js} +1 -1
  210. package/dist/{chunk-JX45ME2Z.js → chunk-TRJLYZHD.js} +1 -1
  211. package/dist/{chunk-RNBO3DEN.js → chunk-UKKJMCNH.js} +1 -1
  212. package/dist/chunk-ULBEEHG4.js +204 -0
  213. package/dist/{chunk-UDO4JYVU.cjs → chunk-VGTUK3QD.cjs} +2 -2
  214. package/dist/{chunk-4JPVFLVU.js → chunk-VQ7R36AC.js} +1 -1
  215. package/dist/{chunk-IPDIEZBN.cjs → chunk-VVQB5W7U.cjs} +2 -2
  216. package/dist/{chunk-HKZQ56AS.cjs → chunk-VVVATFGK.cjs} +2 -2
  217. package/dist/{chunk-URRL33D5.cjs → chunk-WMTYO5OX.cjs} +2 -2
  218. package/dist/{chunk-U4BMKRG6.js → chunk-WOSSSFXB.js} +1 -1
  219. package/dist/{chunk-OBQIS3KU.js → chunk-WOXXNKTE.js} +1 -1
  220. package/dist/{chunk-WAKSLH7V.cjs → chunk-XKI2OAYV.cjs} +2 -2
  221. package/dist/{chunk-5Y2KLUU6.cjs → chunk-XR4QF6KQ.cjs} +2 -2
  222. package/dist/{chunk-6BERHKDQ.cjs → chunk-XYHTQ523.cjs} +2 -2
  223. package/dist/{chunk-XD6XML3Z.cjs → chunk-XZYZLSUO.cjs} +2 -2
  224. package/dist/chunk-YPSWSI3M.js +21 -0
  225. package/dist/{chunk-4K3MX2J6.js → chunk-YYBIU5BQ.js} +1 -1
  226. package/dist/{chunk-HSGQSTVK.js → chunk-YZA5WZUS.js} +1 -1
  227. package/dist/{chunk-GGBSLAVO.cjs → chunk-Z4LUE424.cjs} +2 -2
  228. package/dist/{chunk-NSOHW3R6.js → chunk-ZV6XYUXS.js} +1 -1
  229. package/dist/consent-CS2ZBZX4.cjs +7 -0
  230. package/dist/consent-NNYHF2N4.js +7 -0
  231. package/dist/customer-portal-D3SLPAHZ.js +7 -0
  232. package/dist/customer-portal-UR3GN4VU.cjs +7 -0
  233. package/dist/dashboard-UHYR5RTY.cjs +7 -0
  234. package/dist/dashboard-UTPGXFW5.js +7 -0
  235. package/dist/data-management-QH2IJ5QV.js +7 -0
  236. package/dist/data-management-TEFRLGSU.cjs +7 -0
  237. package/dist/deduplication-ECVAZVVA.cjs +7 -0
  238. package/dist/deduplication-GYIST22B.js +7 -0
  239. package/dist/design-KUVXMFFK.cjs +7 -0
  240. package/dist/design-YKBXRW5C.js +7 -0
  241. package/dist/document-CY2A2OE7.js +7 -0
  242. package/dist/document-RYQ7MF6U.cjs +7 -0
  243. package/dist/email-settings-TQ5GGDYG.js +7 -0
  244. package/dist/email-settings-TQC34GST.cjs +7 -0
  245. package/dist/email-template-M2VVL4TI.cjs +7 -0
  246. package/dist/email-template-WYROV3UG.js +7 -0
  247. package/dist/entity-FA6PZX6S.js +7 -0
  248. package/dist/entity-IX5NSHPX.cjs +7 -0
  249. package/dist/entity-mapping-7J3IAGKQ.js +7 -0
  250. package/dist/entity-mapping-ZNMFCUKK.cjs +7 -0
  251. package/dist/environments-E3X6NYGX.js +7 -0
  252. package/dist/environments-P2JS4F5N.cjs +7 -0
  253. package/dist/erp-integration-EP2XFEH5.js +7 -0
  254. package/dist/erp-integration-NNV72VFI.cjs +7 -0
  255. package/dist/event-catalog-C45ISVMP.cjs +7 -0
  256. package/dist/event-catalog-D7VJ7WRS.js +7 -0
  257. package/dist/file-UOWBTDIU.cjs +7 -0
  258. package/dist/file-XSN3NAVZ.js +7 -0
  259. package/dist/iban-24GHLFDB.cjs +7 -0
  260. package/dist/iban-LDKYDVQV.js +7 -0
  261. package/dist/index.cjs +107 -100
  262. package/dist/index.d.cts +17 -2
  263. package/dist/index.d.ts +17 -2
  264. package/dist/index.js +58 -51
  265. package/dist/journey-7CKX67M7.js +7 -0
  266. package/dist/journey-EUZ6MVHG.cjs +7 -0
  267. package/dist/kanban-CHTH2ZSY.cjs +7 -0
  268. package/dist/kanban-HI6LL5WY.js +7 -0
  269. package/dist/message-3XZLJR6R.cjs +7 -0
  270. package/dist/message-ZNMCS5YH.js +7 -0
  271. package/dist/metering-DZNZPPY6.cjs +7 -0
  272. package/dist/metering-KOSCPPKB.js +7 -0
  273. package/dist/notes-3AO5GXIT.js +7 -0
  274. package/dist/notes-MPWOQC5J.cjs +7 -0
  275. package/dist/notification-PZOCUYD5.cjs +7 -0
  276. package/dist/notification-VWDZRSFZ.js +7 -0
  277. package/dist/organization-RARYYG2E.cjs +7 -0
  278. package/dist/organization-ZERPH2IH.js +7 -0
  279. package/dist/{organization.d-Bd2Hmk8v.d.cts → organization.d-DqwnNxMg.d.cts} +34 -7
  280. package/dist/{organization.d-Bd2Hmk8v.d.ts → organization.d-DqwnNxMg.d.ts} +34 -7
  281. package/dist/partner-directory-2XMPQWWX.js +7 -0
  282. package/dist/partner-directory-WHNTKQ5E.cjs +7 -0
  283. package/dist/permissions-4T3GFNB4.js +7 -0
  284. package/dist/permissions-FGBIJNN7.cjs +7 -0
  285. package/dist/pricing-4Z4TOETA.cjs +7 -0
  286. package/dist/pricing-C65DTZSX.js +7 -0
  287. package/dist/pricing-tier-NI35WOUP.cjs +7 -0
  288. package/dist/pricing-tier-VUOFK5Q7.js +7 -0
  289. package/dist/purpose-AKOEUHZ4.cjs +7 -0
  290. package/dist/purpose-RBRV3AQZ.js +7 -0
  291. package/dist/sandbox-2KN4X66E.cjs +7 -0
  292. package/dist/sandbox-L2SOOGGR.js +7 -0
  293. package/dist/submission-7BISSPO6.js +7 -0
  294. package/dist/submission-Q24BU4GS.cjs +7 -0
  295. package/dist/targeting-EYGYZD6M.cjs +7 -0
  296. package/dist/targeting-GEJTJN5Z.js +7 -0
  297. package/dist/template-variables-OAYS2E3G.cjs +1148 -0
  298. package/dist/template-variables-VKDJJZUT.js +1148 -0
  299. package/dist/user-EIEOI3OG.js +7 -0
  300. package/dist/user-NJJ7XVKB.cjs +7 -0
  301. package/dist/validation-rules-P6F5P73P.js +7 -0
  302. package/dist/validation-rules-VDU3CIZV.cjs +7 -0
  303. package/dist/webhooks-I7JWU34X.cjs +7 -0
  304. package/dist/webhooks-WPLEHVPX.js +7 -0
  305. package/dist/workflow-3LLURW3H.js +7 -0
  306. package/dist/workflow-RAGQDYXT.cjs +7 -0
  307. package/dist/workflow-definition-B6ELOZUR.cjs +7 -0
  308. package/dist/workflow-definition-D24CRCK2.js +7 -0
  309. package/docs/access-token.md +440 -0
  310. package/docs/address-suggestions.md +256 -0
  311. package/docs/address.md +284 -0
  312. package/docs/ai-agents.md +1891 -0
  313. package/docs/app.md +3388 -0
  314. package/docs/audit-logs.md +242 -0
  315. package/docs/automation.md +4044 -0
  316. package/docs/billing.md +783 -0
  317. package/docs/blueprint-manifest.md +3234 -0
  318. package/docs/consent.md +213 -0
  319. package/docs/customer-portal.md +11399 -0
  320. package/docs/dashboard.md +640 -0
  321. package/docs/data-management.md +883 -0
  322. package/docs/deduplication.md +135 -0
  323. package/docs/design.md +1273 -0
  324. package/docs/document.md +590 -0
  325. package/docs/email-settings.md +1544 -0
  326. package/docs/email-template.md +1197 -0
  327. package/docs/entity-mapping.md +2864 -0
  328. package/docs/entity.md +9595 -0
  329. package/docs/environments.md +259 -0
  330. package/docs/erp-integration.md +4572 -0
  331. package/docs/event-catalog.md +835 -0
  332. package/docs/file.md +1453 -0
  333. package/docs/iban.md +61 -0
  334. package/docs/journey.md +2268 -0
  335. package/docs/kanban.md +882 -0
  336. package/docs/message.md +2122 -0
  337. package/docs/metering.md +1431 -0
  338. package/docs/notes.md +670 -0
  339. package/docs/notification.md +1207 -0
  340. package/docs/organization.md +733 -0
  341. package/docs/partner-directory.md +1197 -0
  342. package/docs/permissions.md +1047 -0
  343. package/docs/pricing-tier.md +81 -0
  344. package/docs/pricing.md +5923 -0
  345. package/docs/purpose.md +283 -0
  346. package/docs/sandbox.md +389 -0
  347. package/docs/submission.md +195 -0
  348. package/docs/targeting.md +959 -0
  349. package/docs/template-variables.md +1141 -0
  350. package/docs/user.md +2555 -0
  351. package/docs/validation-rules.md +1597 -0
  352. package/docs/webhooks.md +996 -0
  353. package/docs/workflow-definition.md +3842 -0
  354. package/docs/workflow.md +4465 -0
  355. package/package.json +3 -2
  356. package/dist/chunk-GMBRXWMD.cjs +0 -14
  357. package/dist/chunk-L43U5IO3.js +0 -14
  358. package/dist/chunk-XE25WERA.js +0 -125
  359. package/dist/chunk-XEQMAKGA.cjs +0 -125
@@ -0,0 +1,3842 @@
1
+ # Workflows Definitions
2
+
3
+ - **Base URL:** `https://workflows-definition.sls.epilot.io`
4
+ - **Full API Docs:** [https://docs.epilot.io/api/workflow-definition](https://docs.epilot.io/api/workflow-definition)
5
+
6
+ ## Usage
7
+
8
+ ```ts
9
+ import { epilot } from '@epilot/sdk'
10
+
11
+ epilot.authorize(() => '<token>')
12
+ const { data } = await epilot.workflowDefinition.getMaxAllowedLimit(...)
13
+ ```
14
+
15
+ ### Tree-shakeable import
16
+
17
+ ```ts
18
+ import { getClient, authorize } from '@epilot/sdk/workflow-definition'
19
+
20
+ const workflowDefinitionClient = getClient()
21
+ authorize(workflowDefinitionClient, () => '<token>')
22
+ const { data } = await workflowDefinitionClient.getMaxAllowedLimit(...)
23
+ ```
24
+
25
+ ## Operations
26
+
27
+ **Workflows**
28
+ - [`getMaxAllowedLimit`](#getmaxallowedlimit)
29
+ - [`getDefinitions`](#getdefinitions)
30
+ - [`createDefinition`](#createdefinition)
31
+ - [`getDefinition`](#getdefinition)
32
+ - [`updateDefinition`](#updatedefinition)
33
+ - [`deleteDefinition`](#deletedefinition)
34
+ - [`getWorkflowClosingReasons`](#getworkflowclosingreasons)
35
+ - [`setWorkflowClosingReasons`](#setworkflowclosingreasons)
36
+
37
+ **Flows V2**
38
+ - [`listFlowTemplates`](#listflowtemplates)
39
+ - [`createFlowTemplate`](#createflowtemplate)
40
+ - [`searchFlowTemplates`](#searchflowtemplates)
41
+ - [`getFlowTemplate`](#getflowtemplate)
42
+ - [`updateFlowTemplate`](#updateflowtemplate)
43
+ - [`deleteFlowTemplate`](#deleteflowtemplate)
44
+ - [`duplicateFlowTemplate`](#duplicateflowtemplate)
45
+ - [`exportFlowTemplate`](#exportflowtemplate)
46
+ - [`importFlowTemplate`](#importflowtemplate)
47
+
48
+ **Closing Reason**
49
+ - [`getAllClosingReasons`](#getallclosingreasons)
50
+ - [`createClosingReason`](#createclosingreason)
51
+ - [`getClosingReason`](#getclosingreason)
52
+ - [`updateClosingReason`](#updateclosingreason)
53
+ - [`deleteClosingReason`](#deleteclosingreason)
54
+ - [`changeReasonStatus`](#changereasonstatus)
55
+
56
+ **Schemas**
57
+ - [`FlowTemplateBase`](#flowtemplatebase)
58
+ - [`FlowTemplate`](#flowtemplate)
59
+ - [`Version`](#version)
60
+ - [`Trigger`](#trigger)
61
+ - [`ManualTrigger`](#manualtrigger)
62
+ - [`AutomationTrigger`](#automationtrigger)
63
+ - [`JourneyAutomationTrigger`](#journeyautomationtrigger)
64
+ - [`JourneySubmissionTrigger`](#journeysubmissiontrigger)
65
+ - [`CreateFlowTemplate`](#createflowtemplate)
66
+ - [`SearchFlowTemplates`](#searchflowtemplates)
67
+ - [`FlowTemplatesList`](#flowtemplateslist)
68
+ - [`FlowTemplateId`](#flowtemplateid)
69
+ - [`Task`](#task)
70
+ - [`ManualTask`](#manualtask)
71
+ - [`AutomationTask`](#automationtask)
72
+ - [`AutomationConfig`](#automationconfig)
73
+ - [`AiAgentTask`](#aiagenttask)
74
+ - [`AgentConfig`](#agentconfig)
75
+ - [`TriggerMode`](#triggermode)
76
+ - [`ActionSchedule`](#actionschedule)
77
+ - [`ImmediateSchedule`](#immediateschedule)
78
+ - [`DelayedSchedule`](#delayedschedule)
79
+ - [`RelativeSchedule`](#relativeschedule)
80
+ - [`DecisionTask`](#decisiontask)
81
+ - [`TaskBase`](#taskbase)
82
+ - [`Phase`](#phase)
83
+ - [`VariableAssignment`](#variableassignment)
84
+ - [`TaskType`](#tasktype)
85
+ - [`Edge`](#edge)
86
+ - [`Condition`](#condition)
87
+ - [`Statement`](#statement)
88
+ - [`EvaluationSource`](#evaluationsource)
89
+ - [`Operator`](#operator)
90
+ - [`DueDateConfig`](#duedateconfig)
91
+ - [`TimeUnit`](#timeunit)
92
+ - [`EnableRequirement`](#enablerequirement)
93
+ - [`WorkflowDefinition`](#workflowdefinition)
94
+ - [`Step`](#step)
95
+ - [`Section`](#section)
96
+ - [`TriggerType`](#triggertype)
97
+ - [`ItemType`](#itemtype)
98
+ - [`StepType`](#steptype)
99
+ - [`StepJourney`](#stepjourney)
100
+ - [`ECPDetails`](#ecpdetails)
101
+ - [`StepDescription`](#stepdescription)
102
+ - [`MaxAllowedLimit`](#maxallowedlimit)
103
+ - [`DefinitionNotFoundResp`](#definitionnotfoundresp)
104
+ - [`ClosingReasonNotFoundResp`](#closingreasonnotfoundresp)
105
+ - [`ChangeReasonStatusReq`](#changereasonstatusreq)
106
+ - [`ClosingReasons`](#closingreasons)
107
+ - [`ClosingReason`](#closingreason)
108
+ - [`ClosingReasonsStatus`](#closingreasonsstatus)
109
+ - [`ClosingReasonsIds`](#closingreasonsids)
110
+ - [`ClosingReasonId`](#closingreasonid)
111
+ - [`ErrorResp`](#errorresp)
112
+ - [`UpdateEntityAttributes`](#updateentityattributes)
113
+ - [`EntitySync`](#entitysync)
114
+ - [`DynamicDueDate`](#dynamicduedate)
115
+ - [`StepRequirement`](#steprequirement)
116
+ - [`FlowTemplateExport`](#flowtemplateexport)
117
+ - [`FlowTemplateImportResult`](#flowtemplateimportresult)
118
+
119
+ ### `getMaxAllowedLimit`
120
+
121
+ Get limits and number of created executions for an Organization.
122
+
123
+ `GET /v1/workflows/limits/max-allowed`
124
+
125
+ ```ts
126
+ const { data } = await client.getMaxAllowedLimit()
127
+ ```
128
+
129
+ <details>
130
+ <summary>Response</summary>
131
+
132
+ ```json
133
+ {
134
+ "currentNoOfWorkflows": 0,
135
+ "maxAllowed": 0
136
+ }
137
+ ```
138
+
139
+ </details>
140
+
141
+ ---
142
+
143
+ ### `getDefinitions`
144
+
145
+ Retrieve all Workflow Definitions from an Organization
146
+
147
+ `GET /v1/workflows/definitions`
148
+
149
+ ```ts
150
+ const { data } = await client.getDefinitions()
151
+ ```
152
+
153
+ <details>
154
+ <summary>Response</summary>
155
+
156
+ ```json
157
+ [
158
+ {
159
+ "id": "string",
160
+ "name": "string",
161
+ "description": "string",
162
+ "creationTime": "2021-04-27T12:01:13.000Z",
163
+ "enabled": true,
164
+ "lastUpdateTime": "2021-04-27T12:01:13.000Z",
165
+ "dueDate": "2021-04-27T12:00:00.000Z",
166
+ "dynamicDueDate": {
167
+ "numberOfUnits": 0,
168
+ "timePeriod": "minutes",
169
+ "actionTypeCondition": "WORKFLOW_STARTED",
170
+ "stepId": "string",
171
+ "phaseId": "string"
172
+ },
173
+ "userIds": [0],
174
+ "assignedTo": ["string"],
175
+ "enableECPWorkflow": true,
176
+ "flow": [
177
+ {},
178
+ {}
179
+ ],
180
+ "closingReasons": [
181
+ {}
182
+ ],
183
+ "updateEntityAttributes": [
184
+ {}
185
+ ],
186
+ "taxonomies": ["string"],
187
+ "singleClosingReasonSelection": true
188
+ }
189
+ ]
190
+ ```
191
+
192
+ </details>
193
+
194
+ ---
195
+
196
+ ### `createDefinition`
197
+
198
+ Create a Workflow Definition.
199
+
200
+ `POST /v1/workflows/definitions`
201
+
202
+ ```ts
203
+ const { data } = await client.createDefinition(
204
+ null,
205
+ {
206
+ id: 'string',
207
+ name: 'string',
208
+ description: 'string',
209
+ creationTime: '2021-04-27T12:01:13.000Z',
210
+ enabled: true,
211
+ lastUpdateTime: '2021-04-27T12:01:13.000Z',
212
+ dueDate: '2021-04-27T12:00:00.000Z',
213
+ dynamicDueDate: {
214
+ numberOfUnits: 0,
215
+ timePeriod: 'minutes',
216
+ actionTypeCondition: 'WORKFLOW_STARTED',
217
+ stepId: 'string',
218
+ phaseId: 'string'
219
+ },
220
+ userIds: [0],
221
+ assignedTo: ['string'],
222
+ enableECPWorkflow: true,
223
+ flow: [
224
+ {
225
+ id: 'string',
226
+ name: 'string',
227
+ order: 0,
228
+ type: 'STEP',
229
+ dueDate: '2021-04-27T12:00:00.000Z',
230
+ dynamicDueDate: { /* ... */ },
231
+ assignedTo: ['string'],
232
+ steps: [ /* ... */ ],
233
+ taxonomies: ['string']
234
+ },
235
+ {
236
+ id: 'string',
237
+ name: 'string',
238
+ description: { /* ... */ },
239
+ executionType: 'MANUAL',
240
+ automationConfig: { /* ... */ },
241
+ journey: { /* ... */ },
242
+ order: 0,
243
+ dueDate: '2021-04-27T12:00:00.000Z',
244
+ dynamicDueDate: { /* ... */ },
245
+ userIds: [0],
246
+ requirements: [ /* ... */ ],
247
+ assignedTo: ['string'],
248
+ type: 'STEP',
249
+ ecp: { /* ... */ },
250
+ installer: { /* ... */ },
251
+ taxonomies: ['string']
252
+ }
253
+ ],
254
+ closingReasons: [
255
+ {
256
+ id: 'x739cew'
257
+ }
258
+ ],
259
+ updateEntityAttributes: [
260
+ {
261
+ source: 'workflow_status',
262
+ target: { /* ... */ }
263
+ }
264
+ ],
265
+ taxonomies: ['string'],
266
+ singleClosingReasonSelection: true
267
+ },
268
+ )
269
+ ```
270
+
271
+ <details>
272
+ <summary>Response</summary>
273
+
274
+ ```json
275
+ {
276
+ "id": "string",
277
+ "name": "string",
278
+ "description": "string",
279
+ "creationTime": "2021-04-27T12:01:13.000Z",
280
+ "enabled": true,
281
+ "lastUpdateTime": "2021-04-27T12:01:13.000Z",
282
+ "dueDate": "2021-04-27T12:00:00.000Z",
283
+ "dynamicDueDate": {
284
+ "numberOfUnits": 0,
285
+ "timePeriod": "minutes",
286
+ "actionTypeCondition": "WORKFLOW_STARTED",
287
+ "stepId": "string",
288
+ "phaseId": "string"
289
+ },
290
+ "userIds": [0],
291
+ "assignedTo": ["string"],
292
+ "enableECPWorkflow": true,
293
+ "flow": [
294
+ {
295
+ "id": "string",
296
+ "name": "string",
297
+ "order": 0,
298
+ "type": "STEP",
299
+ "dueDate": "2021-04-27T12:00:00.000Z",
300
+ "dynamicDueDate": {},
301
+ "assignedTo": ["string"],
302
+ "steps": [],
303
+ "taxonomies": ["string"]
304
+ },
305
+ {
306
+ "id": "string",
307
+ "name": "string",
308
+ "description": {},
309
+ "executionType": "MANUAL",
310
+ "automationConfig": {},
311
+ "journey": {},
312
+ "order": 0,
313
+ "dueDate": "2021-04-27T12:00:00.000Z",
314
+ "dynamicDueDate": {},
315
+ "userIds": [0],
316
+ "requirements": [],
317
+ "assignedTo": ["string"],
318
+ "type": "STEP",
319
+ "ecp": {},
320
+ "installer": {},
321
+ "taxonomies": ["string"]
322
+ }
323
+ ],
324
+ "closingReasons": [
325
+ {
326
+ "id": "x739cew"
327
+ }
328
+ ],
329
+ "updateEntityAttributes": [
330
+ {
331
+ "source": "workflow_status",
332
+ "target": {}
333
+ }
334
+ ],
335
+ "taxonomies": ["string"],
336
+ "singleClosingReasonSelection": true
337
+ }
338
+ ```
339
+
340
+ </details>
341
+
342
+ ---
343
+
344
+ ### `listFlowTemplates`
345
+
346
+ List all Flow Templates for a customer. Optionally, you can filter flow templates by trigger values.
347
+
348
+ `GET /v2/flows/templates`
349
+
350
+ ```ts
351
+ const { data } = await client.listFlowTemplates({
352
+ trigger_type: 'example',
353
+ trigger_source_id: 'example',
354
+ trigger_schema: 'example',
355
+ })
356
+ ```
357
+
358
+ <details>
359
+ <summary>Response</summary>
360
+
361
+ ```json
362
+ {
363
+ "results": [
364
+ {
365
+ "id": "string",
366
+ "org_id": "string",
367
+ "name": "string",
368
+ "description": "string",
369
+ "trigger": {},
370
+ "enabled": true,
371
+ "version": 2,
372
+ "created_at": "2021-04-27T12:01:13.000Z",
373
+ "updated_at": "2021-04-27T12:01:13.000Z",
374
+ "due_date": "2021-04-27T12:00:00.000Z",
375
+ "due_date_config": {},
376
+ "assigned_to": ["string"],
377
+ "available_in_ecp": true,
378
+ "additional_triggers": [],
379
+ "phases": [],
380
+ "tasks": [],
381
+ "edges": [],
382
+ "closing_reasons": [],
383
+ "entity_sync": [],
384
+ "taxonomies": ["string"],
385
+ "singleClosingReasonSelection": true
386
+ }
387
+ ]
388
+ }
389
+ ```
390
+
391
+ </details>
392
+
393
+ ---
394
+
395
+ ### `createFlowTemplate`
396
+
397
+ Create a new Flow Template.
398
+
399
+ `POST /v2/flows/templates`
400
+
401
+ ```ts
402
+ const { data } = await client.createFlowTemplate(
403
+ null,
404
+ {
405
+ id: 'string',
406
+ org_id: 'string',
407
+ name: 'string',
408
+ description: 'string',
409
+ trigger: {
410
+ type: 'automation',
411
+ automation_id: 'g92j2-sg9ug92hjt1gh-9s9gajgs-a979gg'
412
+ },
413
+ enabled: true,
414
+ version: 2,
415
+ created_at: '2021-04-27T12:01:13.000Z',
416
+ updated_at: '2021-04-27T12:01:13.000Z',
417
+ due_date: '2021-04-27T12:00:00.000Z',
418
+ due_date_config: {
419
+ duration: 0,
420
+ unit: 'minutes',
421
+ type: 'WORKFLOW_STARTED',
422
+ task_id: 'string',
423
+ phase_id: 'string'
424
+ },
425
+ assigned_to: ['string'],
426
+ available_in_ecp: true,
427
+ additional_triggers: [
428
+ {
429
+ id: 'string',
430
+ type: 'manual',
431
+ entity_schema: 'string'
432
+ },
433
+ {
434
+ id: 'string',
435
+ type: 'automation',
436
+ automation_id: 'string',
437
+ trigger_config: [ /* ... */ ]
438
+ },
439
+ /* ... 2 more */
440
+ ],
441
+ phases: [
442
+ {
443
+ id: 'string',
444
+ name: 'string',
445
+ due_date: '2021-04-27T12:00:00.000Z',
446
+ due_date_config: { /* ... */ },
447
+ assigned_to: ['string'],
448
+ taxonomies: ['string']
449
+ }
450
+ ],
451
+ tasks: [
452
+ {
453
+ id: 'string',
454
+ name: 'string',
455
+ description: { /* ... */ },
456
+ journey: { /* ... */ },
457
+ due_date: '2021-04-27T12:00:00.000Z',
458
+ due_date_config: { /* ... */ },
459
+ requirements: [ /* ... */ ],
460
+ assigned_to: ['string'],
461
+ ecp: { /* ... */ },
462
+ installer: { /* ... */ },
463
+ taxonomies: ['string'],
464
+ phase_id: 'string',
465
+ task_type: 'MANUAL'
466
+ },
467
+ {
468
+ id: 'string',
469
+ name: 'string',
470
+ description: { /* ... */ },
471
+ journey: { /* ... */ },
472
+ due_date: '2021-04-27T12:00:00.000Z',
473
+ due_date_config: { /* ... */ },
474
+ requirements: [ /* ... */ ],
475
+ assigned_to: ['string'],
476
+ ecp: { /* ... */ },
477
+ installer: { /* ... */ },
478
+ taxonomies: ['string'],
479
+ phase_id: 'string',
480
+ task_type: 'MANUAL',
481
+ automation_config: { /* ... */ },
482
+ trigger_mode: 'manual',
483
+ schedule: { /* ... */ },
484
+ created_automatically: false
485
+ },
486
+ /* ... 2 more */
487
+ ],
488
+ edges: [
489
+ {
490
+ id: 'string',
491
+ from_id: 'string',
492
+ to_id: 'string',
493
+ condition_id: 'string',
494
+ none_met: true
495
+ }
496
+ ],
497
+ closing_reasons: [
498
+ {
499
+ id: 'string',
500
+ title: 'string',
501
+ status: 'ACTIVE',
502
+ lastUpdateTime: 'string',
503
+ creationTime: 'string'
504
+ }
505
+ ],
506
+ entity_sync: [
507
+ {
508
+ trigger: { /* ... */ },
509
+ target: { /* ... */ },
510
+ value: { /* ... */ }
511
+ }
512
+ ],
513
+ taxonomies: ['string'],
514
+ singleClosingReasonSelection: true
515
+ },
516
+ )
517
+ ```
518
+
519
+ <details>
520
+ <summary>Response</summary>
521
+
522
+ ```json
523
+ {
524
+ "id": "string",
525
+ "org_id": "string",
526
+ "name": "string",
527
+ "description": "string",
528
+ "trigger": {
529
+ "type": "automation",
530
+ "automation_id": "g92j2-sg9ug92hjt1gh-9s9gajgs-a979gg"
531
+ },
532
+ "enabled": true,
533
+ "version": 2,
534
+ "created_at": "2021-04-27T12:01:13.000Z",
535
+ "updated_at": "2021-04-27T12:01:13.000Z",
536
+ "due_date": "2021-04-27T12:00:00.000Z",
537
+ "due_date_config": {
538
+ "duration": 0,
539
+ "unit": "minutes",
540
+ "type": "WORKFLOW_STARTED",
541
+ "task_id": "string",
542
+ "phase_id": "string"
543
+ },
544
+ "assigned_to": ["string"],
545
+ "available_in_ecp": true,
546
+ "additional_triggers": [
547
+ {
548
+ "id": "string",
549
+ "type": "manual",
550
+ "entity_schema": "string"
551
+ },
552
+ {
553
+ "id": "string",
554
+ "type": "automation",
555
+ "automation_id": "string",
556
+ "trigger_config": []
557
+ }
558
+ ],
559
+ "phases": [
560
+ {
561
+ "id": "string",
562
+ "name": "string",
563
+ "due_date": "2021-04-27T12:00:00.000Z",
564
+ "due_date_config": {},
565
+ "assigned_to": ["string"],
566
+ "taxonomies": ["string"]
567
+ }
568
+ ],
569
+ "tasks": [
570
+ {
571
+ "id": "string",
572
+ "name": "string",
573
+ "description": {},
574
+ "journey": {},
575
+ "due_date": "2021-04-27T12:00:00.000Z",
576
+ "due_date_config": {},
577
+ "requirements": [],
578
+ "assigned_to": ["string"],
579
+ "ecp": {},
580
+ "installer": {},
581
+ "taxonomies": ["string"],
582
+ "phase_id": "string",
583
+ "task_type": "MANUAL"
584
+ },
585
+ {
586
+ "id": "string",
587
+ "name": "string",
588
+ "description": {},
589
+ "journey": {},
590
+ "due_date": "2021-04-27T12:00:00.000Z",
591
+ "due_date_config": {},
592
+ "requirements": [],
593
+ "assigned_to": ["string"],
594
+ "ecp": {},
595
+ "installer": {},
596
+ "taxonomies": ["string"],
597
+ "phase_id": "string",
598
+ "task_type": "MANUAL",
599
+ "automation_config": {},
600
+ "trigger_mode": "manual",
601
+ "schedule": {},
602
+ "created_automatically": false
603
+ }
604
+ ],
605
+ "edges": [
606
+ {
607
+ "id": "string",
608
+ "from_id": "string",
609
+ "to_id": "string",
610
+ "condition_id": "string",
611
+ "none_met": true
612
+ }
613
+ ],
614
+ "closing_reasons": [
615
+ {
616
+ "id": "string",
617
+ "title": "string",
618
+ "status": "ACTIVE",
619
+ "lastUpdateTime": "string",
620
+ "creationTime": "string"
621
+ }
622
+ ],
623
+ "entity_sync": [
624
+ {
625
+ "trigger": {},
626
+ "target": {},
627
+ "value": {}
628
+ }
629
+ ],
630
+ "taxonomies": ["string"],
631
+ "singleClosingReasonSelection": true
632
+ }
633
+ ```
634
+
635
+ </details>
636
+
637
+ ---
638
+
639
+ ### `searchFlowTemplates`
640
+
641
+ Search for flow templates by name, trigger type, enabled status, and more.
642
+
643
+ `POST /v2/flows/templates:search`
644
+
645
+ ```ts
646
+ const { data } = await client.searchFlowTemplates(
647
+ null,
648
+ {
649
+ name: 'string',
650
+ definition_id: 'string',
651
+ trigger_type: 'journey_submission',
652
+ enabled: true,
653
+ from: 0,
654
+ size: 0,
655
+ sort_by: 'updated_at',
656
+ sort_order: 'desc'
657
+ },
658
+ )
659
+ ```
660
+
661
+ <details>
662
+ <summary>Response</summary>
663
+
664
+ ```json
665
+ {
666
+ "hits": 0,
667
+ "results": [
668
+ {
669
+ "id": "string",
670
+ "org_id": "string",
671
+ "name": "string",
672
+ "description": "string",
673
+ "trigger": {},
674
+ "enabled": true,
675
+ "version": 2,
676
+ "created_at": "2021-04-27T12:01:13.000Z",
677
+ "updated_at": "2021-04-27T12:01:13.000Z",
678
+ "due_date": "2021-04-27T12:00:00.000Z",
679
+ "due_date_config": {},
680
+ "assigned_to": ["string"],
681
+ "available_in_ecp": true,
682
+ "additional_triggers": [],
683
+ "phases": [],
684
+ "tasks": [],
685
+ "edges": [],
686
+ "closing_reasons": [],
687
+ "entity_sync": [],
688
+ "taxonomies": ["string"],
689
+ "singleClosingReasonSelection": true
690
+ }
691
+ ]
692
+ }
693
+ ```
694
+
695
+ </details>
696
+
697
+ ---
698
+
699
+ ### `getFlowTemplate`
700
+
701
+ Get specific FLow template for a customer
702
+
703
+ `GET /v2/flows/templates/{flowId}`
704
+
705
+ ```ts
706
+ const { data } = await client.getFlowTemplate({
707
+ flowId: 'example',
708
+ })
709
+ ```
710
+
711
+ <details>
712
+ <summary>Response</summary>
713
+
714
+ ```json
715
+ {
716
+ "id": "string",
717
+ "org_id": "string",
718
+ "name": "string",
719
+ "description": "string",
720
+ "trigger": {
721
+ "type": "automation",
722
+ "automation_id": "g92j2-sg9ug92hjt1gh-9s9gajgs-a979gg"
723
+ },
724
+ "enabled": true,
725
+ "version": 2,
726
+ "created_at": "2021-04-27T12:01:13.000Z",
727
+ "updated_at": "2021-04-27T12:01:13.000Z",
728
+ "due_date": "2021-04-27T12:00:00.000Z",
729
+ "due_date_config": {
730
+ "duration": 0,
731
+ "unit": "minutes",
732
+ "type": "WORKFLOW_STARTED",
733
+ "task_id": "string",
734
+ "phase_id": "string"
735
+ },
736
+ "assigned_to": ["string"],
737
+ "available_in_ecp": true,
738
+ "additional_triggers": [
739
+ {
740
+ "id": "string",
741
+ "type": "manual",
742
+ "entity_schema": "string"
743
+ },
744
+ {
745
+ "id": "string",
746
+ "type": "automation",
747
+ "automation_id": "string",
748
+ "trigger_config": []
749
+ }
750
+ ],
751
+ "phases": [
752
+ {
753
+ "id": "string",
754
+ "name": "string",
755
+ "due_date": "2021-04-27T12:00:00.000Z",
756
+ "due_date_config": {},
757
+ "assigned_to": ["string"],
758
+ "taxonomies": ["string"]
759
+ }
760
+ ],
761
+ "tasks": [
762
+ {
763
+ "id": "string",
764
+ "name": "string",
765
+ "description": {},
766
+ "journey": {},
767
+ "due_date": "2021-04-27T12:00:00.000Z",
768
+ "due_date_config": {},
769
+ "requirements": [],
770
+ "assigned_to": ["string"],
771
+ "ecp": {},
772
+ "installer": {},
773
+ "taxonomies": ["string"],
774
+ "phase_id": "string",
775
+ "task_type": "MANUAL"
776
+ },
777
+ {
778
+ "id": "string",
779
+ "name": "string",
780
+ "description": {},
781
+ "journey": {},
782
+ "due_date": "2021-04-27T12:00:00.000Z",
783
+ "due_date_config": {},
784
+ "requirements": [],
785
+ "assigned_to": ["string"],
786
+ "ecp": {},
787
+ "installer": {},
788
+ "taxonomies": ["string"],
789
+ "phase_id": "string",
790
+ "task_type": "MANUAL",
791
+ "automation_config": {},
792
+ "trigger_mode": "manual",
793
+ "schedule": {},
794
+ "created_automatically": false
795
+ }
796
+ ],
797
+ "edges": [
798
+ {
799
+ "id": "string",
800
+ "from_id": "string",
801
+ "to_id": "string",
802
+ "condition_id": "string",
803
+ "none_met": true
804
+ }
805
+ ],
806
+ "closing_reasons": [
807
+ {
808
+ "id": "string",
809
+ "title": "string",
810
+ "status": "ACTIVE",
811
+ "lastUpdateTime": "string",
812
+ "creationTime": "string"
813
+ }
814
+ ],
815
+ "entity_sync": [
816
+ {
817
+ "trigger": {},
818
+ "target": {},
819
+ "value": {}
820
+ }
821
+ ],
822
+ "taxonomies": ["string"],
823
+ "singleClosingReasonSelection": true
824
+ }
825
+ ```
826
+
827
+ </details>
828
+
829
+ ---
830
+
831
+ ### `updateFlowTemplate`
832
+
833
+ Update Flow Template.
834
+
835
+ `PUT /v2/flows/templates/{flowId}`
836
+
837
+ ```ts
838
+ const { data } = await client.updateFlowTemplate(
839
+ {
840
+ flowId: 'example',
841
+ },
842
+ {
843
+ id: 'string',
844
+ org_id: 'string',
845
+ name: 'string',
846
+ description: 'string',
847
+ trigger: {
848
+ type: 'automation',
849
+ automation_id: 'g92j2-sg9ug92hjt1gh-9s9gajgs-a979gg'
850
+ },
851
+ enabled: true,
852
+ version: 2,
853
+ created_at: '2021-04-27T12:01:13.000Z',
854
+ updated_at: '2021-04-27T12:01:13.000Z',
855
+ due_date: '2021-04-27T12:00:00.000Z',
856
+ due_date_config: {
857
+ duration: 0,
858
+ unit: 'minutes',
859
+ type: 'WORKFLOW_STARTED',
860
+ task_id: 'string',
861
+ phase_id: 'string'
862
+ },
863
+ assigned_to: ['string'],
864
+ available_in_ecp: true,
865
+ additional_triggers: [
866
+ {
867
+ id: 'string',
868
+ type: 'manual',
869
+ entity_schema: 'string'
870
+ },
871
+ {
872
+ id: 'string',
873
+ type: 'automation',
874
+ automation_id: 'string',
875
+ trigger_config: [ /* ... */ ]
876
+ },
877
+ /* ... 2 more */
878
+ ],
879
+ phases: [
880
+ {
881
+ id: 'string',
882
+ name: 'string',
883
+ due_date: '2021-04-27T12:00:00.000Z',
884
+ due_date_config: { /* ... */ },
885
+ assigned_to: ['string'],
886
+ taxonomies: ['string']
887
+ }
888
+ ],
889
+ tasks: [
890
+ {
891
+ id: 'string',
892
+ name: 'string',
893
+ description: { /* ... */ },
894
+ journey: { /* ... */ },
895
+ due_date: '2021-04-27T12:00:00.000Z',
896
+ due_date_config: { /* ... */ },
897
+ requirements: [ /* ... */ ],
898
+ assigned_to: ['string'],
899
+ ecp: { /* ... */ },
900
+ installer: { /* ... */ },
901
+ taxonomies: ['string'],
902
+ phase_id: 'string',
903
+ task_type: 'MANUAL'
904
+ },
905
+ {
906
+ id: 'string',
907
+ name: 'string',
908
+ description: { /* ... */ },
909
+ journey: { /* ... */ },
910
+ due_date: '2021-04-27T12:00:00.000Z',
911
+ due_date_config: { /* ... */ },
912
+ requirements: [ /* ... */ ],
913
+ assigned_to: ['string'],
914
+ ecp: { /* ... */ },
915
+ installer: { /* ... */ },
916
+ taxonomies: ['string'],
917
+ phase_id: 'string',
918
+ task_type: 'MANUAL',
919
+ automation_config: { /* ... */ },
920
+ trigger_mode: 'manual',
921
+ schedule: { /* ... */ },
922
+ created_automatically: false
923
+ },
924
+ /* ... 2 more */
925
+ ],
926
+ edges: [
927
+ {
928
+ id: 'string',
929
+ from_id: 'string',
930
+ to_id: 'string',
931
+ condition_id: 'string',
932
+ none_met: true
933
+ }
934
+ ],
935
+ closing_reasons: [
936
+ {
937
+ id: 'string',
938
+ title: 'string',
939
+ status: 'ACTIVE',
940
+ lastUpdateTime: 'string',
941
+ creationTime: 'string'
942
+ }
943
+ ],
944
+ entity_sync: [
945
+ {
946
+ trigger: { /* ... */ },
947
+ target: { /* ... */ },
948
+ value: { /* ... */ }
949
+ }
950
+ ],
951
+ taxonomies: ['string'],
952
+ singleClosingReasonSelection: true
953
+ },
954
+ )
955
+ ```
956
+
957
+ <details>
958
+ <summary>Response</summary>
959
+
960
+ ```json
961
+ {
962
+ "id": "string",
963
+ "org_id": "string",
964
+ "name": "string",
965
+ "description": "string",
966
+ "trigger": {
967
+ "type": "automation",
968
+ "automation_id": "g92j2-sg9ug92hjt1gh-9s9gajgs-a979gg"
969
+ },
970
+ "enabled": true,
971
+ "version": 2,
972
+ "created_at": "2021-04-27T12:01:13.000Z",
973
+ "updated_at": "2021-04-27T12:01:13.000Z",
974
+ "due_date": "2021-04-27T12:00:00.000Z",
975
+ "due_date_config": {
976
+ "duration": 0,
977
+ "unit": "minutes",
978
+ "type": "WORKFLOW_STARTED",
979
+ "task_id": "string",
980
+ "phase_id": "string"
981
+ },
982
+ "assigned_to": ["string"],
983
+ "available_in_ecp": true,
984
+ "additional_triggers": [
985
+ {
986
+ "id": "string",
987
+ "type": "manual",
988
+ "entity_schema": "string"
989
+ },
990
+ {
991
+ "id": "string",
992
+ "type": "automation",
993
+ "automation_id": "string",
994
+ "trigger_config": []
995
+ }
996
+ ],
997
+ "phases": [
998
+ {
999
+ "id": "string",
1000
+ "name": "string",
1001
+ "due_date": "2021-04-27T12:00:00.000Z",
1002
+ "due_date_config": {},
1003
+ "assigned_to": ["string"],
1004
+ "taxonomies": ["string"]
1005
+ }
1006
+ ],
1007
+ "tasks": [
1008
+ {
1009
+ "id": "string",
1010
+ "name": "string",
1011
+ "description": {},
1012
+ "journey": {},
1013
+ "due_date": "2021-04-27T12:00:00.000Z",
1014
+ "due_date_config": {},
1015
+ "requirements": [],
1016
+ "assigned_to": ["string"],
1017
+ "ecp": {},
1018
+ "installer": {},
1019
+ "taxonomies": ["string"],
1020
+ "phase_id": "string",
1021
+ "task_type": "MANUAL"
1022
+ },
1023
+ {
1024
+ "id": "string",
1025
+ "name": "string",
1026
+ "description": {},
1027
+ "journey": {},
1028
+ "due_date": "2021-04-27T12:00:00.000Z",
1029
+ "due_date_config": {},
1030
+ "requirements": [],
1031
+ "assigned_to": ["string"],
1032
+ "ecp": {},
1033
+ "installer": {},
1034
+ "taxonomies": ["string"],
1035
+ "phase_id": "string",
1036
+ "task_type": "MANUAL",
1037
+ "automation_config": {},
1038
+ "trigger_mode": "manual",
1039
+ "schedule": {},
1040
+ "created_automatically": false
1041
+ }
1042
+ ],
1043
+ "edges": [
1044
+ {
1045
+ "id": "string",
1046
+ "from_id": "string",
1047
+ "to_id": "string",
1048
+ "condition_id": "string",
1049
+ "none_met": true
1050
+ }
1051
+ ],
1052
+ "closing_reasons": [
1053
+ {
1054
+ "id": "string",
1055
+ "title": "string",
1056
+ "status": "ACTIVE",
1057
+ "lastUpdateTime": "string",
1058
+ "creationTime": "string"
1059
+ }
1060
+ ],
1061
+ "entity_sync": [
1062
+ {
1063
+ "trigger": {},
1064
+ "target": {},
1065
+ "value": {}
1066
+ }
1067
+ ],
1068
+ "taxonomies": ["string"],
1069
+ "singleClosingReasonSelection": true
1070
+ }
1071
+ ```
1072
+
1073
+ </details>
1074
+
1075
+ ---
1076
+
1077
+ ### `deleteFlowTemplate`
1078
+
1079
+ Delete Flow Template.
1080
+
1081
+ `DELETE /v2/flows/templates/{flowId}`
1082
+
1083
+ ```ts
1084
+ const { data } = await client.deleteFlowTemplate({
1085
+ flowId: 'example',
1086
+ })
1087
+ ```
1088
+
1089
+ ---
1090
+
1091
+ ### `duplicateFlowTemplate`
1092
+
1093
+ Duplicate a Flow Template from an existing workflow.
1094
+
1095
+ `POST /v2/flows/templates/{flowId}/duplicate`
1096
+
1097
+ ```ts
1098
+ const { data } = await client.duplicateFlowTemplate({
1099
+ flowId: 'example',
1100
+ })
1101
+ ```
1102
+
1103
+ <details>
1104
+ <summary>Response</summary>
1105
+
1106
+ ```json
1107
+ {
1108
+ "id": "string",
1109
+ "org_id": "string",
1110
+ "name": "string",
1111
+ "description": "string",
1112
+ "trigger": {
1113
+ "type": "automation",
1114
+ "automation_id": "g92j2-sg9ug92hjt1gh-9s9gajgs-a979gg"
1115
+ },
1116
+ "enabled": true,
1117
+ "version": 2,
1118
+ "created_at": "2021-04-27T12:01:13.000Z",
1119
+ "updated_at": "2021-04-27T12:01:13.000Z",
1120
+ "due_date": "2021-04-27T12:00:00.000Z",
1121
+ "due_date_config": {
1122
+ "duration": 0,
1123
+ "unit": "minutes",
1124
+ "type": "WORKFLOW_STARTED",
1125
+ "task_id": "string",
1126
+ "phase_id": "string"
1127
+ },
1128
+ "assigned_to": ["string"],
1129
+ "available_in_ecp": true,
1130
+ "additional_triggers": [
1131
+ {
1132
+ "id": "string",
1133
+ "type": "manual",
1134
+ "entity_schema": "string"
1135
+ },
1136
+ {
1137
+ "id": "string",
1138
+ "type": "automation",
1139
+ "automation_id": "string",
1140
+ "trigger_config": []
1141
+ }
1142
+ ],
1143
+ "phases": [
1144
+ {
1145
+ "id": "string",
1146
+ "name": "string",
1147
+ "due_date": "2021-04-27T12:00:00.000Z",
1148
+ "due_date_config": {},
1149
+ "assigned_to": ["string"],
1150
+ "taxonomies": ["string"]
1151
+ }
1152
+ ],
1153
+ "tasks": [
1154
+ {
1155
+ "id": "string",
1156
+ "name": "string",
1157
+ "description": {},
1158
+ "journey": {},
1159
+ "due_date": "2021-04-27T12:00:00.000Z",
1160
+ "due_date_config": {},
1161
+ "requirements": [],
1162
+ "assigned_to": ["string"],
1163
+ "ecp": {},
1164
+ "installer": {},
1165
+ "taxonomies": ["string"],
1166
+ "phase_id": "string",
1167
+ "task_type": "MANUAL"
1168
+ },
1169
+ {
1170
+ "id": "string",
1171
+ "name": "string",
1172
+ "description": {},
1173
+ "journey": {},
1174
+ "due_date": "2021-04-27T12:00:00.000Z",
1175
+ "due_date_config": {},
1176
+ "requirements": [],
1177
+ "assigned_to": ["string"],
1178
+ "ecp": {},
1179
+ "installer": {},
1180
+ "taxonomies": ["string"],
1181
+ "phase_id": "string",
1182
+ "task_type": "MANUAL",
1183
+ "automation_config": {},
1184
+ "trigger_mode": "manual",
1185
+ "schedule": {},
1186
+ "created_automatically": false
1187
+ }
1188
+ ],
1189
+ "edges": [
1190
+ {
1191
+ "id": "string",
1192
+ "from_id": "string",
1193
+ "to_id": "string",
1194
+ "condition_id": "string",
1195
+ "none_met": true
1196
+ }
1197
+ ],
1198
+ "closing_reasons": [
1199
+ {
1200
+ "id": "string",
1201
+ "title": "string",
1202
+ "status": "ACTIVE",
1203
+ "lastUpdateTime": "string",
1204
+ "creationTime": "string"
1205
+ }
1206
+ ],
1207
+ "entity_sync": [
1208
+ {
1209
+ "trigger": {},
1210
+ "target": {},
1211
+ "value": {}
1212
+ }
1213
+ ],
1214
+ "taxonomies": ["string"],
1215
+ "singleClosingReasonSelection": true
1216
+ }
1217
+ ```
1218
+
1219
+ </details>
1220
+
1221
+ ---
1222
+
1223
+ ### `exportFlowTemplate`
1224
+
1225
+ Export a Flow Template with all referenced automations resolved and bundled alongside.
1226
+
1227
+ `GET /v2/flows/templates/{flowId}/export`
1228
+
1229
+ ```ts
1230
+ const { data } = await client.exportFlowTemplate({
1231
+ flowId: 'example',
1232
+ })
1233
+ ```
1234
+
1235
+ <details>
1236
+ <summary>Response</summary>
1237
+
1238
+ ```json
1239
+ {
1240
+ "id": "string",
1241
+ "org_id": "string",
1242
+ "name": "string",
1243
+ "description": "string",
1244
+ "trigger": {
1245
+ "type": "automation",
1246
+ "automation_id": "g92j2-sg9ug92hjt1gh-9s9gajgs-a979gg"
1247
+ },
1248
+ "enabled": true,
1249
+ "version": 2,
1250
+ "created_at": "2021-04-27T12:01:13.000Z",
1251
+ "updated_at": "2021-04-27T12:01:13.000Z",
1252
+ "due_date": "2021-04-27T12:00:00.000Z",
1253
+ "due_date_config": {
1254
+ "duration": 0,
1255
+ "unit": "minutes",
1256
+ "type": "WORKFLOW_STARTED",
1257
+ "task_id": "string",
1258
+ "phase_id": "string"
1259
+ },
1260
+ "assigned_to": ["string"],
1261
+ "available_in_ecp": true,
1262
+ "additional_triggers": [
1263
+ {
1264
+ "id": "string",
1265
+ "type": "manual",
1266
+ "entity_schema": "string"
1267
+ },
1268
+ {
1269
+ "id": "string",
1270
+ "type": "automation",
1271
+ "automation_id": "string",
1272
+ "trigger_config": []
1273
+ }
1274
+ ],
1275
+ "phases": [
1276
+ {
1277
+ "id": "string",
1278
+ "name": "string",
1279
+ "due_date": "2021-04-27T12:00:00.000Z",
1280
+ "due_date_config": {},
1281
+ "assigned_to": ["string"],
1282
+ "taxonomies": ["string"]
1283
+ }
1284
+ ],
1285
+ "tasks": [
1286
+ {
1287
+ "id": "string",
1288
+ "name": "string",
1289
+ "description": {},
1290
+ "journey": {},
1291
+ "due_date": "2021-04-27T12:00:00.000Z",
1292
+ "due_date_config": {},
1293
+ "requirements": [],
1294
+ "assigned_to": ["string"],
1295
+ "ecp": {},
1296
+ "installer": {},
1297
+ "taxonomies": ["string"],
1298
+ "phase_id": "string",
1299
+ "task_type": "MANUAL"
1300
+ },
1301
+ {
1302
+ "id": "string",
1303
+ "name": "string",
1304
+ "description": {},
1305
+ "journey": {},
1306
+ "due_date": "2021-04-27T12:00:00.000Z",
1307
+ "due_date_config": {},
1308
+ "requirements": [],
1309
+ "assigned_to": ["string"],
1310
+ "ecp": {},
1311
+ "installer": {},
1312
+ "taxonomies": ["string"],
1313
+ "phase_id": "string",
1314
+ "task_type": "MANUAL",
1315
+ "automation_config": {},
1316
+ "trigger_mode": "manual",
1317
+ "schedule": {},
1318
+ "created_automatically": false
1319
+ }
1320
+ ],
1321
+ "edges": [
1322
+ {
1323
+ "id": "string",
1324
+ "from_id": "string",
1325
+ "to_id": "string",
1326
+ "condition_id": "string",
1327
+ "none_met": true
1328
+ }
1329
+ ],
1330
+ "closing_reasons": [
1331
+ {
1332
+ "id": "string",
1333
+ "title": "string",
1334
+ "status": "ACTIVE",
1335
+ "lastUpdateTime": "string",
1336
+ "creationTime": "string"
1337
+ }
1338
+ ],
1339
+ "entity_sync": [
1340
+ {
1341
+ "trigger": {},
1342
+ "target": {},
1343
+ "value": {}
1344
+ }
1345
+ ],
1346
+ "taxonomies": ["string"],
1347
+ "singleClosingReasonSelection": true,
1348
+ "_resolved_automations": {}
1349
+ }
1350
+ ```
1351
+
1352
+ </details>
1353
+
1354
+ ---
1355
+
1356
+ ### `importFlowTemplate`
1357
+
1358
+ Import a Flow Template from an export payload. Creates all automations and the flow in the caller's organization.
1359
+
1360
+ `POST /v2/flows/templates/import`
1361
+
1362
+ ```ts
1363
+ const { data } = await client.importFlowTemplate(
1364
+ null,
1365
+ {
1366
+ id: 'string',
1367
+ org_id: 'string',
1368
+ name: 'string',
1369
+ description: 'string',
1370
+ trigger: {
1371
+ type: 'automation',
1372
+ automation_id: 'g92j2-sg9ug92hjt1gh-9s9gajgs-a979gg'
1373
+ },
1374
+ enabled: true,
1375
+ version: 2,
1376
+ created_at: '2021-04-27T12:01:13.000Z',
1377
+ updated_at: '2021-04-27T12:01:13.000Z',
1378
+ due_date: '2021-04-27T12:00:00.000Z',
1379
+ due_date_config: {
1380
+ duration: 0,
1381
+ unit: 'minutes',
1382
+ type: 'WORKFLOW_STARTED',
1383
+ task_id: 'string',
1384
+ phase_id: 'string'
1385
+ },
1386
+ assigned_to: ['string'],
1387
+ available_in_ecp: true,
1388
+ additional_triggers: [
1389
+ {
1390
+ id: 'string',
1391
+ type: 'manual',
1392
+ entity_schema: 'string'
1393
+ },
1394
+ {
1395
+ id: 'string',
1396
+ type: 'automation',
1397
+ automation_id: 'string',
1398
+ trigger_config: [ /* ... */ ]
1399
+ },
1400
+ /* ... 2 more */
1401
+ ],
1402
+ phases: [
1403
+ {
1404
+ id: 'string',
1405
+ name: 'string',
1406
+ due_date: '2021-04-27T12:00:00.000Z',
1407
+ due_date_config: { /* ... */ },
1408
+ assigned_to: ['string'],
1409
+ taxonomies: ['string']
1410
+ }
1411
+ ],
1412
+ tasks: [
1413
+ {
1414
+ id: 'string',
1415
+ name: 'string',
1416
+ description: { /* ... */ },
1417
+ journey: { /* ... */ },
1418
+ due_date: '2021-04-27T12:00:00.000Z',
1419
+ due_date_config: { /* ... */ },
1420
+ requirements: [ /* ... */ ],
1421
+ assigned_to: ['string'],
1422
+ ecp: { /* ... */ },
1423
+ installer: { /* ... */ },
1424
+ taxonomies: ['string'],
1425
+ phase_id: 'string',
1426
+ task_type: 'MANUAL'
1427
+ },
1428
+ {
1429
+ id: 'string',
1430
+ name: 'string',
1431
+ description: { /* ... */ },
1432
+ journey: { /* ... */ },
1433
+ due_date: '2021-04-27T12:00:00.000Z',
1434
+ due_date_config: { /* ... */ },
1435
+ requirements: [ /* ... */ ],
1436
+ assigned_to: ['string'],
1437
+ ecp: { /* ... */ },
1438
+ installer: { /* ... */ },
1439
+ taxonomies: ['string'],
1440
+ phase_id: 'string',
1441
+ task_type: 'MANUAL',
1442
+ automation_config: { /* ... */ },
1443
+ trigger_mode: 'manual',
1444
+ schedule: { /* ... */ },
1445
+ created_automatically: false
1446
+ },
1447
+ /* ... 2 more */
1448
+ ],
1449
+ edges: [
1450
+ {
1451
+ id: 'string',
1452
+ from_id: 'string',
1453
+ to_id: 'string',
1454
+ condition_id: 'string',
1455
+ none_met: true
1456
+ }
1457
+ ],
1458
+ closing_reasons: [
1459
+ {
1460
+ id: 'string',
1461
+ title: 'string',
1462
+ status: 'ACTIVE',
1463
+ lastUpdateTime: 'string',
1464
+ creationTime: 'string'
1465
+ }
1466
+ ],
1467
+ entity_sync: [
1468
+ {
1469
+ trigger: { /* ... */ },
1470
+ target: { /* ... */ },
1471
+ value: { /* ... */ }
1472
+ }
1473
+ ],
1474
+ taxonomies: ['string'],
1475
+ singleClosingReasonSelection: true,
1476
+ _resolved_automations: {}
1477
+ },
1478
+ )
1479
+ ```
1480
+
1481
+ <details>
1482
+ <summary>Response</summary>
1483
+
1484
+ ```json
1485
+ {
1486
+ "flow": {
1487
+ "id": "string",
1488
+ "org_id": "string",
1489
+ "name": "string",
1490
+ "description": "string",
1491
+ "trigger": {
1492
+ "type": "automation",
1493
+ "automation_id": "g92j2-sg9ug92hjt1gh-9s9gajgs-a979gg"
1494
+ },
1495
+ "enabled": true,
1496
+ "version": 2,
1497
+ "created_at": "2021-04-27T12:01:13.000Z",
1498
+ "updated_at": "2021-04-27T12:01:13.000Z",
1499
+ "due_date": "2021-04-27T12:00:00.000Z",
1500
+ "due_date_config": {
1501
+ "duration": 0,
1502
+ "unit": "minutes",
1503
+ "type": "WORKFLOW_STARTED",
1504
+ "task_id": "string",
1505
+ "phase_id": "string"
1506
+ },
1507
+ "assigned_to": ["string"],
1508
+ "available_in_ecp": true,
1509
+ "additional_triggers": [
1510
+ {},
1511
+ {}
1512
+ ],
1513
+ "phases": [
1514
+ {}
1515
+ ],
1516
+ "tasks": [
1517
+ {},
1518
+ {}
1519
+ ],
1520
+ "edges": [
1521
+ {}
1522
+ ],
1523
+ "closing_reasons": [
1524
+ {}
1525
+ ],
1526
+ "entity_sync": [
1527
+ {}
1528
+ ],
1529
+ "taxonomies": ["string"],
1530
+ "singleClosingReasonSelection": true
1531
+ },
1532
+ "_id_mappings": {
1533
+ "flow_id": {
1534
+ "old": "string",
1535
+ "new": "string"
1536
+ },
1537
+ "task_ids": {},
1538
+ "automation_ids": {}
1539
+ }
1540
+ }
1541
+ ```
1542
+
1543
+ </details>
1544
+
1545
+ ---
1546
+
1547
+ ### `getDefinition`
1548
+
1549
+ Get specific Definition by id from the Organization.
1550
+
1551
+ `GET /v1/workflows/definitions/{definitionId}`
1552
+
1553
+ ```ts
1554
+ const { data } = await client.getDefinition({
1555
+ definitionId: 'example',
1556
+ })
1557
+ ```
1558
+
1559
+ <details>
1560
+ <summary>Response</summary>
1561
+
1562
+ ```json
1563
+ {
1564
+ "id": "string",
1565
+ "name": "string",
1566
+ "description": "string",
1567
+ "creationTime": "2021-04-27T12:01:13.000Z",
1568
+ "enabled": true,
1569
+ "lastUpdateTime": "2021-04-27T12:01:13.000Z",
1570
+ "dueDate": "2021-04-27T12:00:00.000Z",
1571
+ "dynamicDueDate": {
1572
+ "numberOfUnits": 0,
1573
+ "timePeriod": "minutes",
1574
+ "actionTypeCondition": "WORKFLOW_STARTED",
1575
+ "stepId": "string",
1576
+ "phaseId": "string"
1577
+ },
1578
+ "userIds": [0],
1579
+ "assignedTo": ["string"],
1580
+ "enableECPWorkflow": true,
1581
+ "flow": [
1582
+ {
1583
+ "id": "string",
1584
+ "name": "string",
1585
+ "order": 0,
1586
+ "type": "STEP",
1587
+ "dueDate": "2021-04-27T12:00:00.000Z",
1588
+ "dynamicDueDate": {},
1589
+ "assignedTo": ["string"],
1590
+ "steps": [],
1591
+ "taxonomies": ["string"]
1592
+ },
1593
+ {
1594
+ "id": "string",
1595
+ "name": "string",
1596
+ "description": {},
1597
+ "executionType": "MANUAL",
1598
+ "automationConfig": {},
1599
+ "journey": {},
1600
+ "order": 0,
1601
+ "dueDate": "2021-04-27T12:00:00.000Z",
1602
+ "dynamicDueDate": {},
1603
+ "userIds": [0],
1604
+ "requirements": [],
1605
+ "assignedTo": ["string"],
1606
+ "type": "STEP",
1607
+ "ecp": {},
1608
+ "installer": {},
1609
+ "taxonomies": ["string"]
1610
+ }
1611
+ ],
1612
+ "closingReasons": [
1613
+ {
1614
+ "id": "x739cew"
1615
+ }
1616
+ ],
1617
+ "updateEntityAttributes": [
1618
+ {
1619
+ "source": "workflow_status",
1620
+ "target": {}
1621
+ }
1622
+ ],
1623
+ "taxonomies": ["string"],
1624
+ "singleClosingReasonSelection": true
1625
+ }
1626
+ ```
1627
+
1628
+ </details>
1629
+
1630
+ ---
1631
+
1632
+ ### `updateDefinition`
1633
+
1634
+ Update Workflow Definition.
1635
+
1636
+ `PUT /v1/workflows/definitions/{definitionId}`
1637
+
1638
+ ```ts
1639
+ const { data } = await client.updateDefinition(
1640
+ {
1641
+ definitionId: 'example',
1642
+ },
1643
+ {
1644
+ id: 'string',
1645
+ name: 'string',
1646
+ description: 'string',
1647
+ creationTime: '2021-04-27T12:01:13.000Z',
1648
+ enabled: true,
1649
+ lastUpdateTime: '2021-04-27T12:01:13.000Z',
1650
+ dueDate: '2021-04-27T12:00:00.000Z',
1651
+ dynamicDueDate: {
1652
+ numberOfUnits: 0,
1653
+ timePeriod: 'minutes',
1654
+ actionTypeCondition: 'WORKFLOW_STARTED',
1655
+ stepId: 'string',
1656
+ phaseId: 'string'
1657
+ },
1658
+ userIds: [0],
1659
+ assignedTo: ['string'],
1660
+ enableECPWorkflow: true,
1661
+ flow: [
1662
+ {
1663
+ id: 'string',
1664
+ name: 'string',
1665
+ order: 0,
1666
+ type: 'STEP',
1667
+ dueDate: '2021-04-27T12:00:00.000Z',
1668
+ dynamicDueDate: { /* ... */ },
1669
+ assignedTo: ['string'],
1670
+ steps: [ /* ... */ ],
1671
+ taxonomies: ['string']
1672
+ },
1673
+ {
1674
+ id: 'string',
1675
+ name: 'string',
1676
+ description: { /* ... */ },
1677
+ executionType: 'MANUAL',
1678
+ automationConfig: { /* ... */ },
1679
+ journey: { /* ... */ },
1680
+ order: 0,
1681
+ dueDate: '2021-04-27T12:00:00.000Z',
1682
+ dynamicDueDate: { /* ... */ },
1683
+ userIds: [0],
1684
+ requirements: [ /* ... */ ],
1685
+ assignedTo: ['string'],
1686
+ type: 'STEP',
1687
+ ecp: { /* ... */ },
1688
+ installer: { /* ... */ },
1689
+ taxonomies: ['string']
1690
+ }
1691
+ ],
1692
+ closingReasons: [
1693
+ {
1694
+ id: 'x739cew'
1695
+ }
1696
+ ],
1697
+ updateEntityAttributes: [
1698
+ {
1699
+ source: 'workflow_status',
1700
+ target: { /* ... */ }
1701
+ }
1702
+ ],
1703
+ taxonomies: ['string'],
1704
+ singleClosingReasonSelection: true
1705
+ },
1706
+ )
1707
+ ```
1708
+
1709
+ <details>
1710
+ <summary>Response</summary>
1711
+
1712
+ ```json
1713
+ {
1714
+ "id": "string",
1715
+ "name": "string",
1716
+ "description": "string",
1717
+ "creationTime": "2021-04-27T12:01:13.000Z",
1718
+ "enabled": true,
1719
+ "lastUpdateTime": "2021-04-27T12:01:13.000Z",
1720
+ "dueDate": "2021-04-27T12:00:00.000Z",
1721
+ "dynamicDueDate": {
1722
+ "numberOfUnits": 0,
1723
+ "timePeriod": "minutes",
1724
+ "actionTypeCondition": "WORKFLOW_STARTED",
1725
+ "stepId": "string",
1726
+ "phaseId": "string"
1727
+ },
1728
+ "userIds": [0],
1729
+ "assignedTo": ["string"],
1730
+ "enableECPWorkflow": true,
1731
+ "flow": [
1732
+ {
1733
+ "id": "string",
1734
+ "name": "string",
1735
+ "order": 0,
1736
+ "type": "STEP",
1737
+ "dueDate": "2021-04-27T12:00:00.000Z",
1738
+ "dynamicDueDate": {},
1739
+ "assignedTo": ["string"],
1740
+ "steps": [],
1741
+ "taxonomies": ["string"]
1742
+ },
1743
+ {
1744
+ "id": "string",
1745
+ "name": "string",
1746
+ "description": {},
1747
+ "executionType": "MANUAL",
1748
+ "automationConfig": {},
1749
+ "journey": {},
1750
+ "order": 0,
1751
+ "dueDate": "2021-04-27T12:00:00.000Z",
1752
+ "dynamicDueDate": {},
1753
+ "userIds": [0],
1754
+ "requirements": [],
1755
+ "assignedTo": ["string"],
1756
+ "type": "STEP",
1757
+ "ecp": {},
1758
+ "installer": {},
1759
+ "taxonomies": ["string"]
1760
+ }
1761
+ ],
1762
+ "closingReasons": [
1763
+ {
1764
+ "id": "x739cew"
1765
+ }
1766
+ ],
1767
+ "updateEntityAttributes": [
1768
+ {
1769
+ "source": "workflow_status",
1770
+ "target": {}
1771
+ }
1772
+ ],
1773
+ "taxonomies": ["string"],
1774
+ "singleClosingReasonSelection": true
1775
+ }
1776
+ ```
1777
+
1778
+ </details>
1779
+
1780
+ ---
1781
+
1782
+ ### `deleteDefinition`
1783
+
1784
+ Delete Workflow Definition.
1785
+
1786
+ `DELETE /v1/workflows/definitions/{definitionId}`
1787
+
1788
+ ```ts
1789
+ const { data } = await client.deleteDefinition({
1790
+ definitionId: 'example',
1791
+ })
1792
+ ```
1793
+
1794
+ ---
1795
+
1796
+ ### `getAllClosingReasons`
1797
+
1798
+ Get all Closing Reasons defined in the organization by default all Active.
1799
+
1800
+ `GET /v1/workflows/closing-reasons`
1801
+
1802
+ ```ts
1803
+ const { data } = await client.getAllClosingReasons({
1804
+ includeInactive: true,
1805
+ })
1806
+ ```
1807
+
1808
+ <details>
1809
+ <summary>Response</summary>
1810
+
1811
+ ```json
1812
+ {
1813
+ "reasons": [
1814
+ {
1815
+ "id": "string",
1816
+ "title": "string",
1817
+ "status": "ACTIVE",
1818
+ "lastUpdateTime": "string",
1819
+ "creationTime": "string"
1820
+ }
1821
+ ]
1822
+ }
1823
+ ```
1824
+
1825
+ </details>
1826
+
1827
+ ---
1828
+
1829
+ ### `createClosingReason`
1830
+
1831
+ A created Closing Reason is stored for the organization and will be displayed in the library of reasons.
1832
+
1833
+ `POST /v1/workflows/closing-reasons`
1834
+
1835
+ ```ts
1836
+ const { data } = await client.createClosingReason(
1837
+ null,
1838
+ {
1839
+ id: 'string',
1840
+ title: 'string',
1841
+ status: 'ACTIVE',
1842
+ lastUpdateTime: 'string',
1843
+ creationTime: 'string'
1844
+ },
1845
+ )
1846
+ ```
1847
+
1848
+ <details>
1849
+ <summary>Response</summary>
1850
+
1851
+ ```json
1852
+ {
1853
+ "id": "string",
1854
+ "title": "string",
1855
+ "status": "ACTIVE",
1856
+ "lastUpdateTime": "string",
1857
+ "creationTime": "string"
1858
+ }
1859
+ ```
1860
+
1861
+ </details>
1862
+
1863
+ ---
1864
+
1865
+ ### `getClosingReason`
1866
+
1867
+ Get specific closing reason by id from the organisation.
1868
+
1869
+ `GET /v2/workflows/closing-reasons/{reasonId}`
1870
+
1871
+ ```ts
1872
+ const { data } = await client.getClosingReason({
1873
+ reasonId: 'example',
1874
+ })
1875
+ ```
1876
+
1877
+ <details>
1878
+ <summary>Response</summary>
1879
+
1880
+ ```json
1881
+ {
1882
+ "id": "string",
1883
+ "title": "string",
1884
+ "status": "ACTIVE",
1885
+ "lastUpdateTime": "string",
1886
+ "creationTime": "string"
1887
+ }
1888
+ ```
1889
+
1890
+ </details>
1891
+
1892
+ ---
1893
+
1894
+ ### `updateClosingReason`
1895
+
1896
+ Update an existing closing reason
1897
+
1898
+ `PATCH /v2/workflows/closing-reasons/{reasonId}`
1899
+
1900
+ ```ts
1901
+ const { data } = await client.updateClosingReason(
1902
+ {
1903
+ reasonId: 'example',
1904
+ },
1905
+ {
1906
+ id: 'string',
1907
+ title: 'string',
1908
+ status: 'ACTIVE',
1909
+ lastUpdateTime: 'string',
1910
+ creationTime: 'string'
1911
+ },
1912
+ )
1913
+ ```
1914
+
1915
+ <details>
1916
+ <summary>Response</summary>
1917
+
1918
+ ```json
1919
+ {
1920
+ "id": "string",
1921
+ "title": "string",
1922
+ "status": "ACTIVE",
1923
+ "lastUpdateTime": "string",
1924
+ "creationTime": "string"
1925
+ }
1926
+ ```
1927
+
1928
+ </details>
1929
+
1930
+ ---
1931
+
1932
+ ### `deleteClosingReason`
1933
+
1934
+ Permanently delete a closing reason (Using INACTIVE status is recommended instead)
1935
+
1936
+ `DELETE /v2/workflows/closing-reasons/{reasonId}`
1937
+
1938
+ ```ts
1939
+ const { data } = await client.deleteClosingReason({
1940
+ reasonId: 'example',
1941
+ })
1942
+ ```
1943
+
1944
+ ---
1945
+
1946
+ ### `changeReasonStatus`
1947
+
1948
+ Change the status of a Closing Reason (eg. ACTIVE to INACTIVE).
1949
+
1950
+ `PATCH /v1/workflows/closing-reasons/{reasonId}`
1951
+
1952
+ ```ts
1953
+ const { data } = await client.changeReasonStatus(
1954
+ {
1955
+ reasonId: 'example',
1956
+ },
1957
+ {
1958
+ status: 'ACTIVE'
1959
+ },
1960
+ )
1961
+ ```
1962
+
1963
+ ---
1964
+
1965
+ ### `getWorkflowClosingReasons`
1966
+
1967
+ Returns all closing reasons defined for the workflow.
1968
+
1969
+ `GET /v1/workflows/definitions/{definitionId}/closing-reasons`
1970
+
1971
+ ```ts
1972
+ const { data } = await client.getWorkflowClosingReasons({
1973
+ definitionId: 'example',
1974
+ })
1975
+ ```
1976
+
1977
+ <details>
1978
+ <summary>Response</summary>
1979
+
1980
+ ```json
1981
+ {
1982
+ "reasons": [
1983
+ {
1984
+ "id": "x739cew"
1985
+ }
1986
+ ]
1987
+ }
1988
+ ```
1989
+
1990
+ </details>
1991
+
1992
+ ---
1993
+
1994
+ ### `setWorkflowClosingReasons`
1995
+
1996
+ Sets which closing reasons are defined for this workflow, based on the entire closing reasons catalog.
1997
+
1998
+ `PATCH /v1/workflows/definitions/{definitionId}/closing-reasons`
1999
+
2000
+ ```ts
2001
+ const { data } = await client.setWorkflowClosingReasons(
2002
+ {
2003
+ definitionId: 'example',
2004
+ },
2005
+ {
2006
+ reasons: [
2007
+ {
2008
+ id: 'x739cew'
2009
+ }
2010
+ ]
2011
+ },
2012
+ )
2013
+ ```
2014
+
2015
+ ---
2016
+
2017
+ ## Schemas
2018
+
2019
+ ### `FlowTemplateBase`
2020
+
2021
+ ```ts
2022
+ type FlowTemplateBase = {
2023
+ id?: string
2024
+ org_id?: string
2025
+ name: string
2026
+ description?: string
2027
+ trigger?: {
2028
+ id?: string
2029
+ type: "manual"
2030
+ entity_schema?: string
2031
+ } | {
2032
+ id?: string
2033
+ type: "automation"
2034
+ automation_id?: string
2035
+ trigger_config?: Array<{
2036
+ type: { ... }
2037
+ configuration?: { ... }
2038
+ }>
2039
+ } | {
2040
+ id?: string
2041
+ type: "journey_submission"
2042
+ journey_id: string
2043
+ journey_name?: string
2044
+ automation_id?: string
2045
+ } | {
2046
+ id?: string
2047
+ type: "journey_automation"
2048
+ entity_schema?: string
2049
+ }
2050
+ enabled?: boolean
2051
+ version?: "v1" | "v2" | "v3"
2052
+ created_at?: string
2053
+ updated_at?: string
2054
+ due_date?: string
2055
+ due_date_config?: {
2056
+ duration: number
2057
+ unit: "minutes" | "hours" | "days" | "weeks" | "months"
2058
+ type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED"
2059
+ task_id?: string
2060
+ phase_id?: string
2061
+ }
2062
+ assigned_to?: Array<string | {
2063
+ variable: string
2064
+ value?: string
2065
+ }>
2066
+ available_in_ecp?: boolean
2067
+ additional_triggers?: Array<{
2068
+ id?: string
2069
+ type: "manual"
2070
+ entity_schema?: string
2071
+ } | {
2072
+ id?: string
2073
+ type: "automation"
2074
+ automation_id?: string
2075
+ trigger_config?: Array<{
2076
+ type: { ... }
2077
+ configuration?: { ... }
2078
+ }>
2079
+ } | {
2080
+ id?: string
2081
+ type: "journey_submission"
2082
+ journey_id: string
2083
+ journey_name?: string
2084
+ automation_id?: string
2085
+ } | {
2086
+ id?: string
2087
+ type: "journey_automation"
2088
+ entity_schema?: string
2089
+ }>
2090
+ phases?: Array<{
2091
+ id: string
2092
+ name: string
2093
+ due_date?: string
2094
+ due_date_config?: {
2095
+ duration: { ... }
2096
+ unit: { ... }
2097
+ type: { ... }
2098
+ task_id?: { ... }
2099
+ phase_id?: { ... }
2100
+ }
2101
+ assigned_to?: Array<string | {
2102
+ variable: { ... }
2103
+ value?: { ... }
2104
+ }>
2105
+ taxonomies?: string[]
2106
+ }>
2107
+ tasks: Array<{
2108
+ id: string
2109
+ name: string
2110
+ description?: {
2111
+ enabled?: { ... }
2112
+ value?: { ... }
2113
+ }
2114
+ journey?: {
2115
+ id?: { ... }
2116
+ journeyId?: { ... }
2117
+ name?: { ... }
2118
+ complete_task_automatically?: { ... }
2119
+ }
2120
+ due_date?: string
2121
+ due_date_config?: {
2122
+ // ...
2123
+ }
2124
+ ```
2125
+
2126
+ ### `FlowTemplate`
2127
+
2128
+ ```ts
2129
+ type FlowTemplate = {
2130
+ id?: string
2131
+ org_id?: string
2132
+ name: string
2133
+ description?: string
2134
+ trigger?: {
2135
+ id?: string
2136
+ type: "manual"
2137
+ entity_schema?: string
2138
+ } | {
2139
+ id?: string
2140
+ type: "automation"
2141
+ automation_id?: string
2142
+ trigger_config?: Array<{
2143
+ type: { ... }
2144
+ configuration?: { ... }
2145
+ }>
2146
+ } | {
2147
+ id?: string
2148
+ type: "journey_submission"
2149
+ journey_id: string
2150
+ journey_name?: string
2151
+ automation_id?: string
2152
+ } | {
2153
+ id?: string
2154
+ type: "journey_automation"
2155
+ entity_schema?: string
2156
+ }
2157
+ enabled?: boolean
2158
+ version?: "v1" | "v2" | "v3"
2159
+ created_at?: string
2160
+ updated_at?: string
2161
+ due_date?: string
2162
+ due_date_config?: {
2163
+ duration: number
2164
+ unit: "minutes" | "hours" | "days" | "weeks" | "months"
2165
+ type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED"
2166
+ task_id?: string
2167
+ phase_id?: string
2168
+ }
2169
+ assigned_to?: Array<string | {
2170
+ variable: string
2171
+ value?: string
2172
+ }>
2173
+ available_in_ecp?: boolean
2174
+ additional_triggers?: Array<{
2175
+ id?: string
2176
+ type: "manual"
2177
+ entity_schema?: string
2178
+ } | {
2179
+ id?: string
2180
+ type: "automation"
2181
+ automation_id?: string
2182
+ trigger_config?: Array<{
2183
+ type: { ... }
2184
+ configuration?: { ... }
2185
+ }>
2186
+ } | {
2187
+ id?: string
2188
+ type: "journey_submission"
2189
+ journey_id: string
2190
+ journey_name?: string
2191
+ automation_id?: string
2192
+ } | {
2193
+ id?: string
2194
+ type: "journey_automation"
2195
+ entity_schema?: string
2196
+ }>
2197
+ phases?: Array<{
2198
+ id: string
2199
+ name: string
2200
+ due_date?: string
2201
+ due_date_config?: {
2202
+ duration: { ... }
2203
+ unit: { ... }
2204
+ type: { ... }
2205
+ task_id?: { ... }
2206
+ phase_id?: { ... }
2207
+ }
2208
+ assigned_to?: Array<string | {
2209
+ variable: { ... }
2210
+ value?: { ... }
2211
+ }>
2212
+ taxonomies?: string[]
2213
+ }>
2214
+ tasks: Array<{
2215
+ id: string
2216
+ name: string
2217
+ description?: {
2218
+ enabled?: { ... }
2219
+ value?: { ... }
2220
+ }
2221
+ journey?: {
2222
+ id?: { ... }
2223
+ journeyId?: { ... }
2224
+ name?: { ... }
2225
+ complete_task_automatically?: { ... }
2226
+ }
2227
+ due_date?: string
2228
+ due_date_config?: {
2229
+ // ...
2230
+ }
2231
+ ```
2232
+
2233
+ ### `Version`
2234
+
2235
+ Version of the workflow schema.
2236
+
2237
+ - `v1` – *Deprecated*. The initial version of workflows with limited structure and automation capabilities.
2238
+ - `v2` – Linear workflows. Supports sequential task execution with basic automation triggers.
2239
+ - `v3` – Advanced workflows. Adds support for branching logic
2240
+
2241
+ ```ts
2242
+ type Version = "v1" | "v2" | "v3"
2243
+ ```
2244
+
2245
+ ### `Trigger`
2246
+
2247
+ ```ts
2248
+ type Trigger = {
2249
+ id?: string
2250
+ type: "manual"
2251
+ entity_schema?: string
2252
+ } | {
2253
+ id?: string
2254
+ type: "automation"
2255
+ automation_id?: string
2256
+ trigger_config?: Array<{
2257
+ type: string
2258
+ configuration?: Record<string, unknown>
2259
+ }>
2260
+ } | {
2261
+ id?: string
2262
+ type: "journey_submission"
2263
+ journey_id: string
2264
+ journey_name?: string
2265
+ automation_id?: string
2266
+ } | {
2267
+ id?: string
2268
+ type: "journey_automation"
2269
+ entity_schema?: string
2270
+ }
2271
+ ```
2272
+
2273
+ ### `ManualTrigger`
2274
+
2275
+ ```ts
2276
+ type ManualTrigger = {
2277
+ id?: string
2278
+ type: "manual"
2279
+ entity_schema?: string
2280
+ }
2281
+ ```
2282
+
2283
+ ### `AutomationTrigger`
2284
+
2285
+ ```ts
2286
+ type AutomationTrigger = {
2287
+ id?: string
2288
+ type: "automation"
2289
+ automation_id?: string
2290
+ trigger_config?: Array<{
2291
+ type: string
2292
+ configuration?: Record<string, unknown>
2293
+ }>
2294
+ }
2295
+ ```
2296
+
2297
+ ### `JourneyAutomationTrigger`
2298
+
2299
+ ```ts
2300
+ type JourneyAutomationTrigger = {
2301
+ id?: string
2302
+ type: "journey_automation"
2303
+ entity_schema?: string
2304
+ }
2305
+ ```
2306
+
2307
+ ### `JourneySubmissionTrigger`
2308
+
2309
+ ```ts
2310
+ type JourneySubmissionTrigger = {
2311
+ id?: string
2312
+ type: "journey_submission"
2313
+ journey_id: string
2314
+ journey_name?: string
2315
+ automation_id?: string
2316
+ }
2317
+ ```
2318
+
2319
+ ### `CreateFlowTemplate`
2320
+
2321
+ ```ts
2322
+ type CreateFlowTemplate = {
2323
+ id?: string
2324
+ org_id?: string
2325
+ name: string
2326
+ description?: string
2327
+ trigger?: {
2328
+ id?: string
2329
+ type: "manual"
2330
+ entity_schema?: string
2331
+ } | {
2332
+ id?: string
2333
+ type: "automation"
2334
+ automation_id?: string
2335
+ trigger_config?: Array<{
2336
+ type: { ... }
2337
+ configuration?: { ... }
2338
+ }>
2339
+ } | {
2340
+ id?: string
2341
+ type: "journey_submission"
2342
+ journey_id: string
2343
+ journey_name?: string
2344
+ automation_id?: string
2345
+ } | {
2346
+ id?: string
2347
+ type: "journey_automation"
2348
+ entity_schema?: string
2349
+ }
2350
+ enabled?: boolean
2351
+ version?: "v1" | "v2" | "v3"
2352
+ created_at?: string
2353
+ updated_at?: string
2354
+ due_date?: string
2355
+ due_date_config?: {
2356
+ duration: number
2357
+ unit: "minutes" | "hours" | "days" | "weeks" | "months"
2358
+ type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED"
2359
+ task_id?: string
2360
+ phase_id?: string
2361
+ }
2362
+ assigned_to?: Array<string | {
2363
+ variable: string
2364
+ value?: string
2365
+ }>
2366
+ available_in_ecp?: boolean
2367
+ additional_triggers?: Array<{
2368
+ id?: string
2369
+ type: "manual"
2370
+ entity_schema?: string
2371
+ } | {
2372
+ id?: string
2373
+ type: "automation"
2374
+ automation_id?: string
2375
+ trigger_config?: Array<{
2376
+ type: { ... }
2377
+ configuration?: { ... }
2378
+ }>
2379
+ } | {
2380
+ id?: string
2381
+ type: "journey_submission"
2382
+ journey_id: string
2383
+ journey_name?: string
2384
+ automation_id?: string
2385
+ } | {
2386
+ id?: string
2387
+ type: "journey_automation"
2388
+ entity_schema?: string
2389
+ }>
2390
+ phases?: Array<{
2391
+ id: string
2392
+ name: string
2393
+ due_date?: string
2394
+ due_date_config?: {
2395
+ duration: { ... }
2396
+ unit: { ... }
2397
+ type: { ... }
2398
+ task_id?: { ... }
2399
+ phase_id?: { ... }
2400
+ }
2401
+ assigned_to?: Array<string | {
2402
+ variable: { ... }
2403
+ value?: { ... }
2404
+ }>
2405
+ taxonomies?: string[]
2406
+ }>
2407
+ tasks: Array<{
2408
+ id: string
2409
+ name: string
2410
+ description?: {
2411
+ enabled?: { ... }
2412
+ value?: { ... }
2413
+ }
2414
+ journey?: {
2415
+ id?: { ... }
2416
+ journeyId?: { ... }
2417
+ name?: { ... }
2418
+ complete_task_automatically?: { ... }
2419
+ }
2420
+ due_date?: string
2421
+ due_date_config?: {
2422
+ // ...
2423
+ }
2424
+ ```
2425
+
2426
+ ### `SearchFlowTemplates`
2427
+
2428
+ ```ts
2429
+ type SearchFlowTemplates = {
2430
+ name?: string
2431
+ definition_id?: string
2432
+ trigger_type?: "journey_submission" | "manual" | "automation"
2433
+ enabled?: boolean
2434
+ from?: number
2435
+ size?: number
2436
+ sort_by?: "created_at" | "updated_at"
2437
+ sort_order?: "asc" | "desc"
2438
+ }
2439
+ ```
2440
+
2441
+ ### `FlowTemplatesList`
2442
+
2443
+ ```ts
2444
+ type FlowTemplatesList = {
2445
+ results: Array<{
2446
+ id?: string
2447
+ org_id?: string
2448
+ name: string
2449
+ description?: string
2450
+ trigger?: {
2451
+ id?: { ... }
2452
+ type: { ... }
2453
+ entity_schema?: { ... }
2454
+ } | {
2455
+ id?: { ... }
2456
+ type: { ... }
2457
+ automation_id?: { ... }
2458
+ trigger_config?: { ... }
2459
+ } | {
2460
+ id?: { ... }
2461
+ type: { ... }
2462
+ journey_id: { ... }
2463
+ journey_name?: { ... }
2464
+ automation_id?: { ... }
2465
+ } | {
2466
+ id?: { ... }
2467
+ type: { ... }
2468
+ entity_schema?: { ... }
2469
+ }
2470
+ enabled?: boolean
2471
+ version?: "v1" | "v2" | "v3"
2472
+ created_at?: string
2473
+ updated_at?: string
2474
+ due_date?: string
2475
+ due_date_config?: {
2476
+ duration: { ... }
2477
+ unit: { ... }
2478
+ type: { ... }
2479
+ task_id?: { ... }
2480
+ phase_id?: { ... }
2481
+ }
2482
+ assigned_to?: Array<string | {
2483
+ variable: { ... }
2484
+ value?: { ... }
2485
+ }>
2486
+ available_in_ecp?: boolean
2487
+ additional_triggers?: Array<{
2488
+ id?: { ... }
2489
+ type: { ... }
2490
+ entity_schema?: { ... }
2491
+ } | {
2492
+ id?: { ... }
2493
+ type: { ... }
2494
+ automation_id?: { ... }
2495
+ trigger_config?: { ... }
2496
+ } | {
2497
+ id?: { ... }
2498
+ type: { ... }
2499
+ journey_id: { ... }
2500
+ journey_name?: { ... }
2501
+ automation_id?: { ... }
2502
+ } | {
2503
+ id?: { ... }
2504
+ type: { ... }
2505
+ entity_schema?: { ... }
2506
+ }>
2507
+ phases?: Array<{
2508
+ id: { ... }
2509
+ name: { ... }
2510
+ due_date?: { ... }
2511
+ due_date_config?: { ... }
2512
+ assigned_to?: { ... }
2513
+ taxonomies?: { ... }
2514
+ }>
2515
+ tasks: Array<{
2516
+ id: { ... }
2517
+ name: { ... }
2518
+ description?: { ... }
2519
+ journey?: { ... }
2520
+ due_date?: { ... }
2521
+ due_date_config?: { ... }
2522
+ requirements?: { ... }
2523
+ assigned_to?: { ... }
2524
+ ecp?: { ... }
2525
+ installer?: { ... }
2526
+ taxonomies?: { ... }
2527
+ phase_id?: { ... }
2528
+ task_type: { ... }
2529
+ } | {
2530
+ id: { ... }
2531
+ name: { ... }
2532
+ description?: { ... }
2533
+ journey?: { ... }
2534
+ due_date?: { ... }
2535
+ due_date_config?: { ... }
2536
+ requirements?: { ... }
2537
+ assigned_to?: { ... }
2538
+ ecp?: { ... }
2539
+ installer?: { ... }
2540
+ taxonomies?: { ... }
2541
+ phase_id?: { ... }
2542
+ task_type: { ... }
2543
+ automation_config: { ... }
2544
+ // ...
2545
+ }
2546
+ ```
2547
+
2548
+ ### `FlowTemplateId`
2549
+
2550
+ Short unique id (length 8) to identify the Flow Template.
2551
+
2552
+ ```ts
2553
+ type FlowTemplateId = string
2554
+ ```
2555
+
2556
+ ### `Task`
2557
+
2558
+ ```ts
2559
+ type Task = {
2560
+ id: string
2561
+ name: string
2562
+ description?: {
2563
+ enabled?: boolean
2564
+ value?: string
2565
+ }
2566
+ journey?: {
2567
+ id?: string
2568
+ journeyId?: string
2569
+ name?: string
2570
+ complete_task_automatically?: boolean
2571
+ }
2572
+ due_date?: string
2573
+ due_date_config?: {
2574
+ duration: number
2575
+ unit: "minutes" | "hours" | "days" | "weeks" | "months"
2576
+ type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED"
2577
+ task_id?: string
2578
+ phase_id?: string
2579
+ }
2580
+ requirements?: Array<{
2581
+ task_id?: string
2582
+ phase_id?: string
2583
+ when: "TASK_FINISHED" | "PHASE_FINISHED"
2584
+ }>
2585
+ assigned_to?: Array<string | {
2586
+ variable: string
2587
+ value?: string
2588
+ }>
2589
+ ecp?: {
2590
+ enabled?: boolean
2591
+ label?: string
2592
+ description?: string
2593
+ journey?: {
2594
+ id?: { ... }
2595
+ journeyId?: { ... }
2596
+ name?: { ... }
2597
+ complete_task_automatically?: { ... }
2598
+ }
2599
+ }
2600
+ installer?: {
2601
+ enabled?: boolean
2602
+ label?: string
2603
+ description?: string
2604
+ journey?: {
2605
+ id?: { ... }
2606
+ journeyId?: { ... }
2607
+ name?: { ... }
2608
+ complete_task_automatically?: { ... }
2609
+ }
2610
+ }
2611
+ taxonomies?: string[]
2612
+ phase_id?: string
2613
+ task_type: "MANUAL" | "AUTOMATION" | "DECISION" | "AI_AGENT"
2614
+ } | {
2615
+ id: string
2616
+ name: string
2617
+ description?: {
2618
+ enabled?: boolean
2619
+ value?: string
2620
+ }
2621
+ journey?: {
2622
+ id?: string
2623
+ journeyId?: string
2624
+ name?: string
2625
+ complete_task_automatically?: boolean
2626
+ }
2627
+ due_date?: string
2628
+ due_date_config?: {
2629
+ duration: number
2630
+ unit: "minutes" | "hours" | "days" | "weeks" | "months"
2631
+ type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED"
2632
+ task_id?: string
2633
+ phase_id?: string
2634
+ }
2635
+ requirements?: Array<{
2636
+ task_id?: string
2637
+ phase_id?: string
2638
+ when: "TASK_FINISHED" | "PHASE_FINISHED"
2639
+ }>
2640
+ assigned_to?: Array<string | {
2641
+ variable: string
2642
+ value?: string
2643
+ }>
2644
+ ecp?: {
2645
+ enabled?: boolean
2646
+ label?: string
2647
+ description?: string
2648
+ journey?: {
2649
+ id?: { ... }
2650
+ journeyId?: { ... }
2651
+ name?: { ... }
2652
+ complete_task_automatically?: { ... }
2653
+ }
2654
+ }
2655
+ installer?: {
2656
+ enabled?: boolean
2657
+ label?: string
2658
+ description?: string
2659
+ // ...
2660
+ }
2661
+ ```
2662
+
2663
+ ### `ManualTask`
2664
+
2665
+ ```ts
2666
+ type ManualTask = {
2667
+ id: string
2668
+ name: string
2669
+ description?: {
2670
+ enabled?: boolean
2671
+ value?: string
2672
+ }
2673
+ journey?: {
2674
+ id?: string
2675
+ journeyId?: string
2676
+ name?: string
2677
+ complete_task_automatically?: boolean
2678
+ }
2679
+ due_date?: string
2680
+ due_date_config?: {
2681
+ duration: number
2682
+ unit: "minutes" | "hours" | "days" | "weeks" | "months"
2683
+ type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED"
2684
+ task_id?: string
2685
+ phase_id?: string
2686
+ }
2687
+ requirements?: Array<{
2688
+ task_id?: string
2689
+ phase_id?: string
2690
+ when: "TASK_FINISHED" | "PHASE_FINISHED"
2691
+ }>
2692
+ assigned_to?: Array<string | {
2693
+ variable: string
2694
+ value?: string
2695
+ }>
2696
+ ecp?: {
2697
+ enabled?: boolean
2698
+ label?: string
2699
+ description?: string
2700
+ journey?: {
2701
+ id?: { ... }
2702
+ journeyId?: { ... }
2703
+ name?: { ... }
2704
+ complete_task_automatically?: { ... }
2705
+ }
2706
+ }
2707
+ installer?: {
2708
+ enabled?: boolean
2709
+ label?: string
2710
+ description?: string
2711
+ journey?: {
2712
+ id?: { ... }
2713
+ journeyId?: { ... }
2714
+ name?: { ... }
2715
+ complete_task_automatically?: { ... }
2716
+ }
2717
+ }
2718
+ taxonomies?: string[]
2719
+ phase_id?: string
2720
+ task_type: "MANUAL" | "AUTOMATION" | "DECISION" | "AI_AGENT"
2721
+ }
2722
+ ```
2723
+
2724
+ ### `AutomationTask`
2725
+
2726
+ ```ts
2727
+ type AutomationTask = {
2728
+ id: string
2729
+ name: string
2730
+ description?: {
2731
+ enabled?: boolean
2732
+ value?: string
2733
+ }
2734
+ journey?: {
2735
+ id?: string
2736
+ journeyId?: string
2737
+ name?: string
2738
+ complete_task_automatically?: boolean
2739
+ }
2740
+ due_date?: string
2741
+ due_date_config?: {
2742
+ duration: number
2743
+ unit: "minutes" | "hours" | "days" | "weeks" | "months"
2744
+ type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED"
2745
+ task_id?: string
2746
+ phase_id?: string
2747
+ }
2748
+ requirements?: Array<{
2749
+ task_id?: string
2750
+ phase_id?: string
2751
+ when: "TASK_FINISHED" | "PHASE_FINISHED"
2752
+ }>
2753
+ assigned_to?: Array<string | {
2754
+ variable: string
2755
+ value?: string
2756
+ }>
2757
+ ecp?: {
2758
+ enabled?: boolean
2759
+ label?: string
2760
+ description?: string
2761
+ journey?: {
2762
+ id?: { ... }
2763
+ journeyId?: { ... }
2764
+ name?: { ... }
2765
+ complete_task_automatically?: { ... }
2766
+ }
2767
+ }
2768
+ installer?: {
2769
+ enabled?: boolean
2770
+ label?: string
2771
+ description?: string
2772
+ journey?: {
2773
+ id?: { ... }
2774
+ journeyId?: { ... }
2775
+ name?: { ... }
2776
+ complete_task_automatically?: { ... }
2777
+ }
2778
+ }
2779
+ taxonomies?: string[]
2780
+ phase_id?: string
2781
+ task_type: "MANUAL" | "AUTOMATION" | "DECISION" | "AI_AGENT"
2782
+ automation_config: {
2783
+ flow_id?: string
2784
+ action_config?: {
2785
+ type: { ... }
2786
+ config?: { ... }
2787
+ }
2788
+ }
2789
+ trigger_mode?: "manual" | "automatic"
2790
+ schedule?: {
2791
+ mode?: "immediate"
2792
+ } | {
2793
+ mode: "delayed"
2794
+ duration: number
2795
+ unit: "minutes" | "hours" | "days" | "weeks" | "months"
2796
+ } | {
2797
+ mode: "relative"
2798
+ direction: "before" | "after"
2799
+ duration: number
2800
+ unit: "minutes" | "hours" | "days" | "weeks" | "months"
2801
+ reference: {
2802
+ id: { ... }
2803
+ origin: { ... }
2804
+ schema?: { ... }
2805
+ attribute?: { ... }
2806
+ }
2807
+ }
2808
+ created_automatically?: boolean
2809
+ }
2810
+ ```
2811
+
2812
+ ### `AutomationConfig`
2813
+
2814
+ Configuration for automation execution to run
2815
+
2816
+ ```ts
2817
+ type AutomationConfig = {
2818
+ flow_id?: string
2819
+ action_config?: {
2820
+ type: string
2821
+ config?: Record<string, unknown>
2822
+ }
2823
+ }
2824
+ ```
2825
+
2826
+ ### `AiAgentTask`
2827
+
2828
+ ```ts
2829
+ type AiAgentTask = {
2830
+ id: string
2831
+ name: string
2832
+ description?: {
2833
+ enabled?: boolean
2834
+ value?: string
2835
+ }
2836
+ journey?: {
2837
+ id?: string
2838
+ journeyId?: string
2839
+ name?: string
2840
+ complete_task_automatically?: boolean
2841
+ }
2842
+ due_date?: string
2843
+ due_date_config?: {
2844
+ duration: number
2845
+ unit: "minutes" | "hours" | "days" | "weeks" | "months"
2846
+ type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED"
2847
+ task_id?: string
2848
+ phase_id?: string
2849
+ }
2850
+ requirements?: Array<{
2851
+ task_id?: string
2852
+ phase_id?: string
2853
+ when: "TASK_FINISHED" | "PHASE_FINISHED"
2854
+ }>
2855
+ assigned_to?: Array<string | {
2856
+ variable: string
2857
+ value?: string
2858
+ }>
2859
+ ecp?: {
2860
+ enabled?: boolean
2861
+ label?: string
2862
+ description?: string
2863
+ journey?: {
2864
+ id?: { ... }
2865
+ journeyId?: { ... }
2866
+ name?: { ... }
2867
+ complete_task_automatically?: { ... }
2868
+ }
2869
+ }
2870
+ installer?: {
2871
+ enabled?: boolean
2872
+ label?: string
2873
+ description?: string
2874
+ journey?: {
2875
+ id?: { ... }
2876
+ journeyId?: { ... }
2877
+ name?: { ... }
2878
+ complete_task_automatically?: { ... }
2879
+ }
2880
+ }
2881
+ taxonomies?: string[]
2882
+ phase_id?: string
2883
+ task_type: "MANUAL" | "AUTOMATION" | "DECISION" | "AI_AGENT"
2884
+ agent_config?: {
2885
+ agent_id: string
2886
+ }
2887
+ }
2888
+ ```
2889
+
2890
+ ### `AgentConfig`
2891
+
2892
+ Configuration for AI Agent to run
2893
+
2894
+ ```ts
2895
+ type AgentConfig = {
2896
+ agent_id: string
2897
+ }
2898
+ ```
2899
+
2900
+ ### `TriggerMode`
2901
+
2902
+ ```ts
2903
+ type TriggerMode = "manual" | "automatic"
2904
+ ```
2905
+
2906
+ ### `ActionSchedule`
2907
+
2908
+ ```ts
2909
+ type ActionSchedule = {
2910
+ mode?: "immediate"
2911
+ } | {
2912
+ mode: "delayed"
2913
+ duration: number
2914
+ unit: "minutes" | "hours" | "days" | "weeks" | "months"
2915
+ } | {
2916
+ mode: "relative"
2917
+ direction: "before" | "after"
2918
+ duration: number
2919
+ unit: "minutes" | "hours" | "days" | "weeks" | "months"
2920
+ reference: {
2921
+ id: string
2922
+ origin: "flow_started" | "task_completed" | "trigger_entity_attribute"
2923
+ schema?: string
2924
+ attribute?: string
2925
+ }
2926
+ }
2927
+ ```
2928
+
2929
+ ### `ImmediateSchedule`
2930
+
2931
+ ```ts
2932
+ type ImmediateSchedule = {
2933
+ mode?: "immediate"
2934
+ }
2935
+ ```
2936
+
2937
+ ### `DelayedSchedule`
2938
+
2939
+ ```ts
2940
+ type DelayedSchedule = {
2941
+ mode: "delayed"
2942
+ duration: number
2943
+ unit: "minutes" | "hours" | "days" | "weeks" | "months"
2944
+ }
2945
+ ```
2946
+
2947
+ ### `RelativeSchedule`
2948
+
2949
+ ```ts
2950
+ type RelativeSchedule = {
2951
+ mode: "relative"
2952
+ direction: "before" | "after"
2953
+ duration: number
2954
+ unit: "minutes" | "hours" | "days" | "weeks" | "months"
2955
+ reference: {
2956
+ id: string
2957
+ origin: "flow_started" | "task_completed" | "trigger_entity_attribute"
2958
+ schema?: string
2959
+ attribute?: string
2960
+ }
2961
+ }
2962
+ ```
2963
+
2964
+ ### `DecisionTask`
2965
+
2966
+ ```ts
2967
+ type DecisionTask = {
2968
+ id: string
2969
+ name: string
2970
+ description?: {
2971
+ enabled?: boolean
2972
+ value?: string
2973
+ }
2974
+ journey?: {
2975
+ id?: string
2976
+ journeyId?: string
2977
+ name?: string
2978
+ complete_task_automatically?: boolean
2979
+ }
2980
+ due_date?: string
2981
+ due_date_config?: {
2982
+ duration: number
2983
+ unit: "minutes" | "hours" | "days" | "weeks" | "months"
2984
+ type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED"
2985
+ task_id?: string
2986
+ phase_id?: string
2987
+ }
2988
+ requirements?: Array<{
2989
+ task_id?: string
2990
+ phase_id?: string
2991
+ when: "TASK_FINISHED" | "PHASE_FINISHED"
2992
+ }>
2993
+ assigned_to?: Array<string | {
2994
+ variable: string
2995
+ value?: string
2996
+ }>
2997
+ ecp?: {
2998
+ enabled?: boolean
2999
+ label?: string
3000
+ description?: string
3001
+ journey?: {
3002
+ id?: { ... }
3003
+ journeyId?: { ... }
3004
+ name?: { ... }
3005
+ complete_task_automatically?: { ... }
3006
+ }
3007
+ }
3008
+ installer?: {
3009
+ enabled?: boolean
3010
+ label?: string
3011
+ description?: string
3012
+ journey?: {
3013
+ id?: { ... }
3014
+ journeyId?: { ... }
3015
+ name?: { ... }
3016
+ complete_task_automatically?: { ... }
3017
+ }
3018
+ }
3019
+ taxonomies?: string[]
3020
+ phase_id?: string
3021
+ task_type: "MANUAL" | "AUTOMATION" | "DECISION" | "AI_AGENT"
3022
+ trigger_mode: "manual" | "automatic"
3023
+ conditions: Array<{
3024
+ id: string
3025
+ branch_name: string
3026
+ logical_operator: "AND" | "OR"
3027
+ statements: Array<{
3028
+ id: { ... }
3029
+ source: { ... }
3030
+ operator: { ... }
3031
+ values: { ... }
3032
+ }>
3033
+ }>
3034
+ schedule?: {
3035
+ mode: "delayed"
3036
+ duration: number
3037
+ unit: "minutes" | "hours" | "days" | "weeks" | "months"
3038
+ } | {
3039
+ mode: "relative"
3040
+ direction: "before" | "after"
3041
+ duration: number
3042
+ unit: "minutes" | "hours" | "days" | "weeks" | "months"
3043
+ reference: {
3044
+ id: { ... }
3045
+ origin: { ... }
3046
+ schema?: { ... }
3047
+ attribute?: { ... }
3048
+ }
3049
+ }
3050
+ loop_config?: {
3051
+ loop_branch_id: string
3052
+ exit_branch_id: string
3053
+ max_iterations: number
3054
+ }
3055
+ }
3056
+ ```
3057
+
3058
+ ### `TaskBase`
3059
+
3060
+ ```ts
3061
+ type TaskBase = {
3062
+ id: string
3063
+ name: string
3064
+ description?: {
3065
+ enabled?: boolean
3066
+ value?: string
3067
+ }
3068
+ journey?: {
3069
+ id?: string
3070
+ journeyId?: string
3071
+ name?: string
3072
+ complete_task_automatically?: boolean
3073
+ }
3074
+ due_date?: string
3075
+ due_date_config?: {
3076
+ duration: number
3077
+ unit: "minutes" | "hours" | "days" | "weeks" | "months"
3078
+ type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED"
3079
+ task_id?: string
3080
+ phase_id?: string
3081
+ }
3082
+ requirements?: Array<{
3083
+ task_id?: string
3084
+ phase_id?: string
3085
+ when: "TASK_FINISHED" | "PHASE_FINISHED"
3086
+ }>
3087
+ assigned_to?: Array<string | {
3088
+ variable: string
3089
+ value?: string
3090
+ }>
3091
+ ecp?: {
3092
+ enabled?: boolean
3093
+ label?: string
3094
+ description?: string
3095
+ journey?: {
3096
+ id?: { ... }
3097
+ journeyId?: { ... }
3098
+ name?: { ... }
3099
+ complete_task_automatically?: { ... }
3100
+ }
3101
+ }
3102
+ installer?: {
3103
+ enabled?: boolean
3104
+ label?: string
3105
+ description?: string
3106
+ journey?: {
3107
+ id?: { ... }
3108
+ journeyId?: { ... }
3109
+ name?: { ... }
3110
+ complete_task_automatically?: { ... }
3111
+ }
3112
+ }
3113
+ taxonomies?: string[]
3114
+ phase_id?: string
3115
+ task_type: "MANUAL" | "AUTOMATION" | "DECISION" | "AI_AGENT"
3116
+ }
3117
+ ```
3118
+
3119
+ ### `Phase`
3120
+
3121
+ ```ts
3122
+ type Phase = {
3123
+ id: string
3124
+ name: string
3125
+ due_date?: string
3126
+ due_date_config?: {
3127
+ duration: number
3128
+ unit: "minutes" | "hours" | "days" | "weeks" | "months"
3129
+ type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED"
3130
+ task_id?: string
3131
+ phase_id?: string
3132
+ }
3133
+ assigned_to?: Array<string | {
3134
+ variable: string
3135
+ value?: string
3136
+ }>
3137
+ taxonomies?: string[]
3138
+ }
3139
+ ```
3140
+
3141
+ ### `VariableAssignment`
3142
+
3143
+ Represents a variable assignment with its expression and optional resolved value. Used for dynamic user assignments that get resolved during workflow execution.
3144
+
3145
+ ```ts
3146
+ type VariableAssignment = {
3147
+ variable: string
3148
+ value?: string
3149
+ }
3150
+ ```
3151
+
3152
+ ### `TaskType`
3153
+
3154
+ ```ts
3155
+ type TaskType = "MANUAL" | "AUTOMATION" | "DECISION" | "AI_AGENT"
3156
+ ```
3157
+
3158
+ ### `Edge`
3159
+
3160
+ ```ts
3161
+ type Edge = {
3162
+ id: string
3163
+ from_id: string
3164
+ to_id: string
3165
+ condition_id?: string
3166
+ none_met?: boolean
3167
+ }
3168
+ ```
3169
+
3170
+ ### `Condition`
3171
+
3172
+ ```ts
3173
+ type Condition = {
3174
+ id: string
3175
+ branch_name: string
3176
+ logical_operator: "AND" | "OR"
3177
+ statements: Array<{
3178
+ id: string
3179
+ source: {
3180
+ id?: { ... }
3181
+ origin?: { ... }
3182
+ origin_type?: { ... }
3183
+ schema?: { ... }
3184
+ attribute?: { ... }
3185
+ attribute_type?: { ... }
3186
+ attribute_repeatable?: { ... }
3187
+ attribute_operation?: { ... }
3188
+ attribute_sub_field?: { ... }
3189
+ }
3190
+ operator: "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"
3191
+ values: string[]
3192
+ }>
3193
+ }
3194
+ ```
3195
+
3196
+ ### `Statement`
3197
+
3198
+ ```ts
3199
+ type Statement = {
3200
+ id: string
3201
+ source: {
3202
+ id?: string
3203
+ origin?: "trigger" | "action"
3204
+ origin_type?: "entity" | "workflow" | "journey_block"
3205
+ schema?: string
3206
+ attribute?: string
3207
+ attribute_type?: "string" | "text" | "number" | "boolean" | "date" | "datetime" | "tags" | "country" | "email" | "phone" | "product" | "price" | "status" | "relation" | "multiselect" | "select" | "radio" | "relation_user" | "purpose" | "label" | "message_email_address"
3208
+ attribute_repeatable?: boolean
3209
+ attribute_operation?: "all" | "updated" | "added" | "deleted"
3210
+ attribute_sub_field?: string
3211
+ }
3212
+ operator: "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"
3213
+ values: string[]
3214
+ }
3215
+ ```
3216
+
3217
+ ### `EvaluationSource`
3218
+
3219
+ ```ts
3220
+ type EvaluationSource = {
3221
+ id?: string
3222
+ origin?: "trigger" | "action"
3223
+ origin_type?: "entity" | "workflow" | "journey_block"
3224
+ schema?: string
3225
+ attribute?: string
3226
+ attribute_type?: "string" | "text" | "number" | "boolean" | "date" | "datetime" | "tags" | "country" | "email" | "phone" | "product" | "price" | "status" | "relation" | "multiselect" | "select" | "radio" | "relation_user" | "purpose" | "label" | "message_email_address"
3227
+ attribute_repeatable?: boolean
3228
+ attribute_operation?: "all" | "updated" | "added" | "deleted"
3229
+ attribute_sub_field?: string
3230
+ }
3231
+ ```
3232
+
3233
+ ### `Operator`
3234
+
3235
+ ```ts
3236
+ type Operator = "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"
3237
+ ```
3238
+
3239
+ ### `DueDateConfig`
3240
+
3241
+ Set due date for the task based on a dynamic condition
3242
+
3243
+ ```ts
3244
+ type DueDateConfig = {
3245
+ duration: number
3246
+ unit: "minutes" | "hours" | "days" | "weeks" | "months"
3247
+ type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED"
3248
+ task_id?: string
3249
+ phase_id?: string
3250
+ }
3251
+ ```
3252
+
3253
+ ### `TimeUnit`
3254
+
3255
+ ```ts
3256
+ type TimeUnit = "minutes" | "hours" | "days" | "weeks" | "months"
3257
+ ```
3258
+
3259
+ ### `EnableRequirement`
3260
+
3261
+ describe the requirement for a task to be enabled
3262
+
3263
+ ```ts
3264
+ type EnableRequirement = {
3265
+ task_id?: string
3266
+ phase_id?: string
3267
+ when: "TASK_FINISHED" | "PHASE_FINISHED"
3268
+ }
3269
+ ```
3270
+
3271
+ ### `WorkflowDefinition`
3272
+
3273
+ ```ts
3274
+ type WorkflowDefinition = {
3275
+ id?: string
3276
+ name: string
3277
+ description?: string
3278
+ creationTime?: string
3279
+ enabled?: boolean
3280
+ lastUpdateTime?: string
3281
+ dueDate?: string
3282
+ dynamicDueDate?: {
3283
+ numberOfUnits: number
3284
+ timePeriod: "minutes" | "hours" | "days" | "weeks" | "months"
3285
+ actionTypeCondition: "WORKFLOW_STARTED" | "STEP_CLOSED" | "PHASE_FINISHED"
3286
+ stepId?: string
3287
+ phaseId?: string
3288
+ }
3289
+ userIds?: number[]
3290
+ assignedTo?: string[]
3291
+ enableECPWorkflow?: boolean
3292
+ flow: Array<{
3293
+ id?: string
3294
+ name: string
3295
+ order: number
3296
+ type: "STEP" | "SECTION"
3297
+ dueDate?: string
3298
+ dynamicDueDate?: {
3299
+ numberOfUnits: { ... }
3300
+ timePeriod: { ... }
3301
+ actionTypeCondition: { ... }
3302
+ stepId?: { ... }
3303
+ phaseId?: { ... }
3304
+ }
3305
+ assignedTo?: string[]
3306
+ steps: Array<{
3307
+ id?: { ... }
3308
+ name: { ... }
3309
+ description?: { ... }
3310
+ executionType?: { ... }
3311
+ automationConfig?: { ... }
3312
+ journey?: { ... }
3313
+ order: { ... }
3314
+ dueDate?: { ... }
3315
+ dynamicDueDate?: { ... }
3316
+ userIds?: { ... }
3317
+ requirements?: { ... }
3318
+ assignedTo?: { ... }
3319
+ type: { ... }
3320
+ ecp?: { ... }
3321
+ installer?: { ... }
3322
+ taxonomies?: { ... }
3323
+ }>
3324
+ taxonomies?: string[]
3325
+ } | {
3326
+ id?: string
3327
+ name: string
3328
+ description?: {
3329
+ enabled?: { ... }
3330
+ value?: { ... }
3331
+ }
3332
+ executionType?: "MANUAL" | "AUTOMATION"
3333
+ automationConfig?: {
3334
+ flowId: { ... }
3335
+ }
3336
+ journey?: {
3337
+ id?: { ... }
3338
+ journeyId?: { ... }
3339
+ name?: { ... }
3340
+ complete_task_automatically?: { ... }
3341
+ }
3342
+ order: number
3343
+ dueDate?: string
3344
+ dynamicDueDate?: {
3345
+ numberOfUnits: { ... }
3346
+ timePeriod: { ... }
3347
+ actionTypeCondition: { ... }
3348
+ stepId?: { ... }
3349
+ phaseId?: { ... }
3350
+ }
3351
+ userIds?: number[]
3352
+ requirements?: Array<{
3353
+ definitionId: { ... }
3354
+ type: { ... }
3355
+ condition: { ... }
3356
+ }>
3357
+ assignedTo?: string[]
3358
+ type: "STEP" | "SECTION"
3359
+ ecp?: {
3360
+ enabled?: { ... }
3361
+ label?: { ... }
3362
+ description?: { ... }
3363
+ journey?: { ... }
3364
+ }
3365
+ installer?: {
3366
+ enabled?: { ... }
3367
+ label?: { ... }
3368
+ description?: { ... }
3369
+ journey?: { ... }
3370
+ }
3371
+ taxonomies?: string[]
3372
+ }>
3373
+ closingReasons?: Array<{
3374
+ // ...
3375
+ }
3376
+ ```
3377
+
3378
+ ### `Step`
3379
+
3380
+ Action that needs to be done in a Workflow
3381
+
3382
+ ```ts
3383
+ type Step = {
3384
+ id?: string
3385
+ name: string
3386
+ description?: {
3387
+ enabled?: boolean
3388
+ value?: string
3389
+ }
3390
+ executionType?: "MANUAL" | "AUTOMATION"
3391
+ automationConfig?: {
3392
+ flowId: string
3393
+ }
3394
+ journey?: {
3395
+ id?: string
3396
+ journeyId?: string
3397
+ name?: string
3398
+ complete_task_automatically?: boolean
3399
+ }
3400
+ order: number
3401
+ dueDate?: string
3402
+ dynamicDueDate?: {
3403
+ numberOfUnits: number
3404
+ timePeriod: "minutes" | "hours" | "days" | "weeks" | "months"
3405
+ actionTypeCondition: "WORKFLOW_STARTED" | "STEP_CLOSED" | "PHASE_FINISHED"
3406
+ stepId?: string
3407
+ phaseId?: string
3408
+ }
3409
+ userIds?: number[]
3410
+ requirements?: Array<{
3411
+ definitionId: string
3412
+ type: "STEP" | "SECTION"
3413
+ condition: "CLOSED"
3414
+ }>
3415
+ assignedTo?: string[]
3416
+ type: "STEP" | "SECTION"
3417
+ ecp?: {
3418
+ enabled?: boolean
3419
+ label?: string
3420
+ description?: string
3421
+ journey?: {
3422
+ id?: { ... }
3423
+ journeyId?: { ... }
3424
+ name?: { ... }
3425
+ complete_task_automatically?: { ... }
3426
+ }
3427
+ }
3428
+ installer?: {
3429
+ enabled?: boolean
3430
+ label?: string
3431
+ description?: string
3432
+ journey?: {
3433
+ id?: { ... }
3434
+ journeyId?: { ... }
3435
+ name?: { ... }
3436
+ complete_task_automatically?: { ... }
3437
+ }
3438
+ }
3439
+ taxonomies?: string[]
3440
+ }
3441
+ ```
3442
+
3443
+ ### `Section`
3444
+
3445
+ A group of Steps that define the progress of the Workflow
3446
+
3447
+ ```ts
3448
+ type Section = {
3449
+ id?: string
3450
+ name: string
3451
+ order: number
3452
+ type: "STEP" | "SECTION"
3453
+ dueDate?: string
3454
+ dynamicDueDate?: {
3455
+ numberOfUnits: number
3456
+ timePeriod: "minutes" | "hours" | "days" | "weeks" | "months"
3457
+ actionTypeCondition: "WORKFLOW_STARTED" | "STEP_CLOSED" | "PHASE_FINISHED"
3458
+ stepId?: string
3459
+ phaseId?: string
3460
+ }
3461
+ assignedTo?: string[]
3462
+ steps: Array<{
3463
+ id?: string
3464
+ name: string
3465
+ description?: {
3466
+ enabled?: { ... }
3467
+ value?: { ... }
3468
+ }
3469
+ executionType?: "MANUAL" | "AUTOMATION"
3470
+ automationConfig?: {
3471
+ flowId: { ... }
3472
+ }
3473
+ journey?: {
3474
+ id?: { ... }
3475
+ journeyId?: { ... }
3476
+ name?: { ... }
3477
+ complete_task_automatically?: { ... }
3478
+ }
3479
+ order: number
3480
+ dueDate?: string
3481
+ dynamicDueDate?: {
3482
+ numberOfUnits: { ... }
3483
+ timePeriod: { ... }
3484
+ actionTypeCondition: { ... }
3485
+ stepId?: { ... }
3486
+ phaseId?: { ... }
3487
+ }
3488
+ userIds?: number[]
3489
+ requirements?: Array<{
3490
+ definitionId: { ... }
3491
+ type: { ... }
3492
+ condition: { ... }
3493
+ }>
3494
+ assignedTo?: string[]
3495
+ type: "STEP" | "SECTION"
3496
+ ecp?: {
3497
+ enabled?: { ... }
3498
+ label?: { ... }
3499
+ description?: { ... }
3500
+ journey?: { ... }
3501
+ }
3502
+ installer?: {
3503
+ enabled?: { ... }
3504
+ label?: { ... }
3505
+ description?: { ... }
3506
+ journey?: { ... }
3507
+ }
3508
+ taxonomies?: string[]
3509
+ }>
3510
+ taxonomies?: string[]
3511
+ }
3512
+ ```
3513
+
3514
+ ### `TriggerType`
3515
+
3516
+ ```ts
3517
+ type TriggerType = "MANUAL" | "AUTOMATIC"
3518
+ ```
3519
+
3520
+ ### `ItemType`
3521
+
3522
+ ```ts
3523
+ type ItemType = "STEP" | "SECTION"
3524
+ ```
3525
+
3526
+ ### `StepType`
3527
+
3528
+ ```ts
3529
+ type StepType = "MANUAL" | "AUTOMATION"
3530
+ ```
3531
+
3532
+ ### `StepJourney`
3533
+
3534
+ ```ts
3535
+ type StepJourney = {
3536
+ id?: string
3537
+ journeyId?: string
3538
+ name?: string
3539
+ complete_task_automatically?: boolean
3540
+ }
3541
+ ```
3542
+
3543
+ ### `ECPDetails`
3544
+
3545
+ Details regarding ECP for the workflow step
3546
+
3547
+ ```ts
3548
+ type ECPDetails = {
3549
+ enabled?: boolean
3550
+ label?: string
3551
+ description?: string
3552
+ journey?: {
3553
+ id?: string
3554
+ journeyId?: string
3555
+ name?: string
3556
+ complete_task_automatically?: boolean
3557
+ }
3558
+ }
3559
+ ```
3560
+
3561
+ ### `StepDescription`
3562
+
3563
+ Longer information regarding Task
3564
+
3565
+ ```ts
3566
+ type StepDescription = {
3567
+ enabled?: boolean
3568
+ value?: string
3569
+ }
3570
+ ```
3571
+
3572
+ ### `MaxAllowedLimit`
3573
+
3574
+ ```ts
3575
+ type MaxAllowedLimit = {
3576
+ currentNoOfWorkflows?: number
3577
+ maxAllowed?: number
3578
+ }
3579
+ ```
3580
+
3581
+ ### `DefinitionNotFoundResp`
3582
+
3583
+ Definition could be not found
3584
+
3585
+ ```ts
3586
+ type DefinitionNotFoundResp = {
3587
+ message?: string
3588
+ }
3589
+ ```
3590
+
3591
+ ### `ClosingReasonNotFoundResp`
3592
+
3593
+ Closing reason could be not found
3594
+
3595
+ ```ts
3596
+ type ClosingReasonNotFoundResp = {
3597
+ message?: string
3598
+ }
3599
+ ```
3600
+
3601
+ ### `ChangeReasonStatusReq`
3602
+
3603
+ ```ts
3604
+ type ChangeReasonStatusReq = {
3605
+ status: "ACTIVE" | "INACTIVE"
3606
+ }
3607
+ ```
3608
+
3609
+ ### `ClosingReasons`
3610
+
3611
+ ```ts
3612
+ type ClosingReasons = {
3613
+ reasons: Array<{
3614
+ id?: string
3615
+ title: string
3616
+ status: "ACTIVE" | "INACTIVE"
3617
+ lastUpdateTime?: string
3618
+ creationTime?: string
3619
+ }>
3620
+ }
3621
+ ```
3622
+
3623
+ ### `ClosingReason`
3624
+
3625
+ One Closing reason for a workflow
3626
+
3627
+ ```ts
3628
+ type ClosingReason = {
3629
+ id?: string
3630
+ title: string
3631
+ status: "ACTIVE" | "INACTIVE"
3632
+ lastUpdateTime?: string
3633
+ creationTime?: string
3634
+ }
3635
+ ```
3636
+
3637
+ ### `ClosingReasonsStatus`
3638
+
3639
+ ```ts
3640
+ type ClosingReasonsStatus = "ACTIVE" | "INACTIVE"
3641
+ ```
3642
+
3643
+ ### `ClosingReasonsIds`
3644
+
3645
+ ```ts
3646
+ type ClosingReasonsIds = {
3647
+ reasons: Array<{
3648
+ id: string
3649
+ }>
3650
+ }
3651
+ ```
3652
+
3653
+ ### `ClosingReasonId`
3654
+
3655
+ ```ts
3656
+ type ClosingReasonId = {
3657
+ id: string
3658
+ }
3659
+ ```
3660
+
3661
+ ### `ErrorResp`
3662
+
3663
+ ```ts
3664
+ type ErrorResp = {
3665
+ message?: string
3666
+ }
3667
+ ```
3668
+
3669
+ ### `UpdateEntityAttributes`
3670
+
3671
+ ```ts
3672
+ type UpdateEntityAttributes = {
3673
+ source: "workflow_status" | "current_section" | "current_step"
3674
+ target: {
3675
+ entitySchema: string
3676
+ entityAttribute: string
3677
+ }
3678
+ }
3679
+ ```
3680
+
3681
+ ### `EntitySync`
3682
+
3683
+ ```ts
3684
+ type EntitySync = {
3685
+ trigger: {
3686
+ event: "FlowStarted" | "FlowCompleted" | "FlowCancelled" | "FlowReopened" | "FlowDeleted" | "FlowAssigned" | "FlowDueDateChanged" | "FlowContextsChanged" | "TaskUpdated" | "CurrTaskChanged" | "TaskCompleted" | "TaskSkipped" | "TaskMarkedInProgress" | "TaskMarkedOnHold" | "PhaseUpdated" | "PhaseCompleted" | "PhaseSkipped" | "PhaseMarkedInProgress"
3687
+ filter?: {
3688
+ task_template_id?: { ... }
3689
+ phase_template_id?: { ... }
3690
+ }
3691
+ }
3692
+ value: {
3693
+ source: "workflow_name" | "workflow_status" | "workflow_assigned_to" | "task_name" | "task_status" | "task_assigned_to" | "phase_name" | "phase_status" | "phase_assigned_to" | "custom_value"
3694
+ value?: string
3695
+ }
3696
+ target: {
3697
+ entitySchema: string
3698
+ entityAttribute: string
3699
+ }
3700
+ }
3701
+ ```
3702
+
3703
+ ### `DynamicDueDate`
3704
+
3705
+ set a Duedate for a step then a specific
3706
+
3707
+ ```ts
3708
+ type DynamicDueDate = {
3709
+ numberOfUnits: number
3710
+ timePeriod: "minutes" | "hours" | "days" | "weeks" | "months"
3711
+ actionTypeCondition: "WORKFLOW_STARTED" | "STEP_CLOSED" | "PHASE_FINISHED"
3712
+ stepId?: string
3713
+ phaseId?: string
3714
+ }
3715
+ ```
3716
+
3717
+ ### `StepRequirement`
3718
+
3719
+ describe the requirement for step enablement
3720
+
3721
+ ```ts
3722
+ type StepRequirement = {
3723
+ definitionId: string
3724
+ type: "STEP" | "SECTION"
3725
+ condition: "CLOSED"
3726
+ }
3727
+ ```
3728
+
3729
+ ### `FlowTemplateExport`
3730
+
3731
+ ```ts
3732
+ type FlowTemplateExport = {
3733
+ _resolved_automations?: Record<string, object>
3734
+ }
3735
+ ```
3736
+
3737
+ ### `FlowTemplateImportResult`
3738
+
3739
+ ```ts
3740
+ type FlowTemplateImportResult = {
3741
+ flow?: {
3742
+ id?: string
3743
+ org_id?: string
3744
+ name: string
3745
+ description?: string
3746
+ trigger?: {
3747
+ id?: { ... }
3748
+ type: { ... }
3749
+ entity_schema?: { ... }
3750
+ } | {
3751
+ id?: { ... }
3752
+ type: { ... }
3753
+ automation_id?: { ... }
3754
+ trigger_config?: { ... }
3755
+ } | {
3756
+ id?: { ... }
3757
+ type: { ... }
3758
+ journey_id: { ... }
3759
+ journey_name?: { ... }
3760
+ automation_id?: { ... }
3761
+ } | {
3762
+ id?: { ... }
3763
+ type: { ... }
3764
+ entity_schema?: { ... }
3765
+ }
3766
+ enabled?: boolean
3767
+ version?: "v1" | "v2" | "v3"
3768
+ created_at?: string
3769
+ updated_at?: string
3770
+ due_date?: string
3771
+ due_date_config?: {
3772
+ duration: { ... }
3773
+ unit: { ... }
3774
+ type: { ... }
3775
+ task_id?: { ... }
3776
+ phase_id?: { ... }
3777
+ }
3778
+ assigned_to?: Array<string | {
3779
+ variable: { ... }
3780
+ value?: { ... }
3781
+ }>
3782
+ available_in_ecp?: boolean
3783
+ additional_triggers?: Array<{
3784
+ id?: { ... }
3785
+ type: { ... }
3786
+ entity_schema?: { ... }
3787
+ } | {
3788
+ id?: { ... }
3789
+ type: { ... }
3790
+ automation_id?: { ... }
3791
+ trigger_config?: { ... }
3792
+ } | {
3793
+ id?: { ... }
3794
+ type: { ... }
3795
+ journey_id: { ... }
3796
+ journey_name?: { ... }
3797
+ automation_id?: { ... }
3798
+ } | {
3799
+ id?: { ... }
3800
+ type: { ... }
3801
+ entity_schema?: { ... }
3802
+ }>
3803
+ phases?: Array<{
3804
+ id: { ... }
3805
+ name: { ... }
3806
+ due_date?: { ... }
3807
+ due_date_config?: { ... }
3808
+ assigned_to?: { ... }
3809
+ taxonomies?: { ... }
3810
+ }>
3811
+ tasks: Array<{
3812
+ id: { ... }
3813
+ name: { ... }
3814
+ description?: { ... }
3815
+ journey?: { ... }
3816
+ due_date?: { ... }
3817
+ due_date_config?: { ... }
3818
+ requirements?: { ... }
3819
+ assigned_to?: { ... }
3820
+ ecp?: { ... }
3821
+ installer?: { ... }
3822
+ taxonomies?: { ... }
3823
+ phase_id?: { ... }
3824
+ task_type: { ... }
3825
+ } | {
3826
+ id: { ... }
3827
+ name: { ... }
3828
+ description?: { ... }
3829
+ journey?: { ... }
3830
+ due_date?: { ... }
3831
+ due_date_config?: { ... }
3832
+ requirements?: { ... }
3833
+ assigned_to?: { ... }
3834
+ ecp?: { ... }
3835
+ installer?: { ... }
3836
+ taxonomies?: { ... }
3837
+ phase_id?: { ... }
3838
+ task_type: { ... }
3839
+ automation_config: { ... }
3840
+ // ...
3841
+ }
3842
+ ```