@epilot/sdk 2.4.4-alpha.0 → 2.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (381) hide show
  1. package/definitions/app.json +137 -58
  2. package/definitions/customer-portal-runtime.json +1 -1
  3. package/definitions/customer-portal.json +496 -24
  4. package/definitions/entity.json +185 -8
  5. package/definitions/webhooks-runtime.json +1 -1
  6. package/definitions/webhooks.json +134 -4
  7. package/dist/access-token.d-CnmUTOlq.d.cts +552 -0
  8. package/dist/access-token.d-CnmUTOlq.d.ts +552 -0
  9. package/dist/address-suggestions.d-_YwTOR-9.d.cts +339 -0
  10. package/dist/address-suggestions.d-_YwTOR-9.d.ts +339 -0
  11. package/dist/address.d-CwAPOVxa.d.cts +437 -0
  12. package/dist/address.d-CwAPOVxa.d.ts +437 -0
  13. package/dist/ai-agents.d-OkXfr2bz.d.cts +1339 -0
  14. package/dist/ai-agents.d-OkXfr2bz.d.ts +1339 -0
  15. package/dist/apis/access-token.cjs +6 -6
  16. package/dist/apis/access-token.d.cts +18 -0
  17. package/dist/apis/access-token.d.ts +12 -9
  18. package/dist/apis/access-token.js +1 -1
  19. package/dist/apis/address-suggestions.cjs +6 -6
  20. package/dist/apis/address-suggestions.d.cts +18 -0
  21. package/dist/apis/address-suggestions.d.ts +12 -9
  22. package/dist/apis/address-suggestions.js +1 -1
  23. package/dist/apis/address.cjs +6 -6
  24. package/dist/apis/address.d.cts +18 -0
  25. package/dist/apis/address.d.ts +12 -9
  26. package/dist/apis/address.js +1 -1
  27. package/dist/apis/ai-agents.cjs +6 -6
  28. package/dist/apis/ai-agents.d.cts +18 -0
  29. package/dist/apis/ai-agents.d.ts +12 -9
  30. package/dist/apis/ai-agents.js +1 -1
  31. package/dist/apis/app.cjs +8 -8
  32. package/dist/apis/app.d.cts +18 -0
  33. package/dist/apis/app.d.ts +12 -9
  34. package/dist/apis/app.js +2 -2
  35. package/dist/apis/audit-logs.cjs +6 -6
  36. package/dist/apis/audit-logs.d.cts +18 -0
  37. package/dist/apis/audit-logs.d.ts +12 -9
  38. package/dist/apis/audit-logs.js +1 -1
  39. package/dist/apis/automation.cjs +6 -6
  40. package/dist/apis/automation.d.cts +18 -0
  41. package/dist/apis/automation.d.ts +12 -9
  42. package/dist/apis/automation.js +1 -1
  43. package/dist/apis/billing.cjs +6 -6
  44. package/dist/apis/billing.d.cts +18 -0
  45. package/dist/apis/billing.d.ts +12 -9
  46. package/dist/apis/billing.js +1 -1
  47. package/dist/apis/blueprint-manifest.cjs +6 -6
  48. package/dist/apis/blueprint-manifest.d.cts +18 -0
  49. package/dist/apis/blueprint-manifest.d.ts +12 -9
  50. package/dist/apis/blueprint-manifest.js +1 -1
  51. package/dist/apis/calendar.cjs +6 -6
  52. package/dist/apis/calendar.d.cts +18 -0
  53. package/dist/apis/calendar.d.ts +12 -9
  54. package/dist/apis/calendar.js +1 -1
  55. package/dist/apis/configuration-hub.cjs +6 -6
  56. package/dist/apis/configuration-hub.d.cts +18 -0
  57. package/dist/apis/configuration-hub.d.ts +12 -9
  58. package/dist/apis/configuration-hub.js +1 -1
  59. package/dist/apis/consent.cjs +6 -6
  60. package/dist/apis/consent.d.cts +18 -0
  61. package/dist/apis/consent.d.ts +12 -9
  62. package/dist/apis/consent.js +1 -1
  63. package/dist/apis/customer-portal.cjs +8 -8
  64. package/dist/apis/customer-portal.d.cts +18 -0
  65. package/dist/apis/customer-portal.d.ts +12 -9
  66. package/dist/apis/customer-portal.js +2 -2
  67. package/dist/apis/dashboard.cjs +6 -6
  68. package/dist/apis/dashboard.d.cts +18 -0
  69. package/dist/apis/dashboard.d.ts +12 -9
  70. package/dist/apis/dashboard.js +1 -1
  71. package/dist/apis/data-governance.cjs +6 -6
  72. package/dist/apis/data-governance.d.cts +18 -0
  73. package/dist/apis/data-governance.d.ts +12 -9
  74. package/dist/apis/data-governance.js +1 -1
  75. package/dist/apis/deduplication.cjs +6 -6
  76. package/dist/apis/deduplication.d.cts +18 -0
  77. package/dist/apis/deduplication.d.ts +12 -9
  78. package/dist/apis/deduplication.js +1 -1
  79. package/dist/apis/design.cjs +6 -6
  80. package/dist/apis/design.d.cts +18 -0
  81. package/dist/apis/design.d.ts +12 -9
  82. package/dist/apis/design.js +1 -1
  83. package/dist/apis/document.cjs +6 -6
  84. package/dist/apis/document.d.cts +18 -0
  85. package/dist/apis/document.d.ts +12 -9
  86. package/dist/apis/document.js +1 -1
  87. package/dist/apis/email-settings.cjs +6 -6
  88. package/dist/apis/email-settings.d.cts +18 -0
  89. package/dist/apis/email-settings.d.ts +12 -9
  90. package/dist/apis/email-settings.js +1 -1
  91. package/dist/apis/email-template.cjs +6 -6
  92. package/dist/apis/email-template.d.cts +18 -0
  93. package/dist/apis/email-template.d.ts +12 -9
  94. package/dist/apis/email-template.js +1 -1
  95. package/dist/apis/entity-mapping.cjs +6 -6
  96. package/dist/apis/entity-mapping.d.cts +18 -0
  97. package/dist/apis/entity-mapping.d.ts +12 -9
  98. package/dist/apis/entity-mapping.js +1 -1
  99. package/dist/apis/entity.cjs +6 -6
  100. package/dist/apis/entity.d.cts +18 -0
  101. package/dist/apis/entity.d.ts +12 -9
  102. package/dist/apis/entity.js +1 -1
  103. package/dist/apis/environments.cjs +6 -6
  104. package/dist/apis/environments.d.cts +18 -0
  105. package/dist/apis/environments.d.ts +12 -9
  106. package/dist/apis/environments.js +1 -1
  107. package/dist/apis/event-catalog.cjs +6 -6
  108. package/dist/apis/event-catalog.d.cts +18 -0
  109. package/dist/apis/event-catalog.d.ts +12 -9
  110. package/dist/apis/event-catalog.js +1 -1
  111. package/dist/apis/file.cjs +6 -6
  112. package/dist/apis/file.d.cts +18 -0
  113. package/dist/apis/file.d.ts +12 -9
  114. package/dist/apis/file.js +1 -1
  115. package/dist/apis/iban.cjs +6 -6
  116. package/dist/apis/iban.d.cts +18 -0
  117. package/dist/apis/iban.d.ts +12 -9
  118. package/dist/apis/iban.js +1 -1
  119. package/dist/apis/integration-toolkit.cjs +6 -6
  120. package/dist/apis/integration-toolkit.d.cts +18 -0
  121. package/dist/apis/integration-toolkit.d.ts +12 -9
  122. package/dist/apis/integration-toolkit.js +1 -1
  123. package/dist/apis/journey.cjs +6 -6
  124. package/dist/apis/journey.d.cts +18 -0
  125. package/dist/apis/journey.d.ts +12 -9
  126. package/dist/apis/journey.js +1 -1
  127. package/dist/apis/kanban.cjs +6 -6
  128. package/dist/apis/kanban.d.cts +18 -0
  129. package/dist/apis/kanban.d.ts +12 -9
  130. package/dist/apis/kanban.js +1 -1
  131. package/dist/apis/message.cjs +6 -6
  132. package/dist/apis/message.d.cts +18 -0
  133. package/dist/apis/message.d.ts +12 -9
  134. package/dist/apis/message.js +1 -1
  135. package/dist/apis/metering.cjs +6 -6
  136. package/dist/apis/metering.d.cts +18 -0
  137. package/dist/apis/metering.d.ts +12 -9
  138. package/dist/apis/metering.js +1 -1
  139. package/dist/apis/notes.cjs +6 -6
  140. package/dist/apis/notes.d.cts +18 -0
  141. package/dist/apis/notes.d.ts +12 -9
  142. package/dist/apis/notes.js +1 -1
  143. package/dist/apis/notification.cjs +6 -6
  144. package/dist/apis/notification.d.cts +18 -0
  145. package/dist/apis/notification.d.ts +12 -9
  146. package/dist/apis/notification.js +1 -1
  147. package/dist/apis/organization.cjs +6 -6
  148. package/dist/apis/organization.d.cts +18 -0
  149. package/dist/apis/organization.d.ts +12 -9
  150. package/dist/apis/organization.js +1 -1
  151. package/dist/apis/partner-directory.cjs +6 -6
  152. package/dist/apis/partner-directory.d.cts +18 -0
  153. package/dist/apis/partner-directory.d.ts +12 -9
  154. package/dist/apis/partner-directory.js +1 -1
  155. package/dist/apis/permissions.cjs +6 -6
  156. package/dist/apis/permissions.d.cts +18 -0
  157. package/dist/apis/permissions.d.ts +12 -9
  158. package/dist/apis/permissions.js +1 -1
  159. package/dist/apis/pricing-tier.cjs +6 -6
  160. package/dist/apis/pricing-tier.d.cts +18 -0
  161. package/dist/apis/pricing-tier.d.ts +12 -9
  162. package/dist/apis/pricing-tier.js +1 -1
  163. package/dist/apis/pricing.cjs +6 -6
  164. package/dist/apis/pricing.d.cts +18 -0
  165. package/dist/apis/pricing.d.ts +12 -9
  166. package/dist/apis/pricing.js +1 -1
  167. package/dist/apis/purpose.cjs +6 -6
  168. package/dist/apis/purpose.d.cts +18 -0
  169. package/dist/apis/purpose.d.ts +12 -9
  170. package/dist/apis/purpose.js +1 -1
  171. package/dist/apis/query.cjs +6 -6
  172. package/dist/apis/query.d.cts +18 -0
  173. package/dist/apis/query.d.ts +12 -9
  174. package/dist/apis/query.js +1 -1
  175. package/dist/apis/sandbox.cjs +6 -6
  176. package/dist/apis/sandbox.d.cts +18 -0
  177. package/dist/apis/sandbox.d.ts +12 -9
  178. package/dist/apis/sandbox.js +1 -1
  179. package/dist/apis/sharing.cjs +6 -6
  180. package/dist/apis/sharing.d.cts +18 -0
  181. package/dist/apis/sharing.d.ts +12 -9
  182. package/dist/apis/sharing.js +1 -1
  183. package/dist/apis/submission.cjs +6 -6
  184. package/dist/apis/submission.d.cts +18 -0
  185. package/dist/apis/submission.d.ts +12 -9
  186. package/dist/apis/submission.js +1 -1
  187. package/dist/apis/target.cjs +6 -6
  188. package/dist/apis/target.d.cts +597 -0
  189. package/dist/apis/target.d.ts +591 -9
  190. package/dist/apis/target.js +1 -1
  191. package/dist/apis/targeting.cjs +6 -6
  192. package/dist/apis/targeting.d.cts +18 -0
  193. package/dist/apis/targeting.d.ts +12 -9
  194. package/dist/apis/targeting.js +1 -1
  195. package/dist/apis/template-variables.cjs +6 -6
  196. package/dist/apis/template-variables.d.cts +18 -0
  197. package/dist/apis/template-variables.d.ts +12 -9
  198. package/dist/apis/template-variables.js +1 -1
  199. package/dist/apis/user.cjs +6 -6
  200. package/dist/apis/user.d.cts +18 -0
  201. package/dist/apis/user.d.ts +12 -9
  202. package/dist/apis/user.js +1 -1
  203. package/dist/apis/validation-rules.cjs +6 -6
  204. package/dist/apis/validation-rules.d.cts +18 -0
  205. package/dist/apis/validation-rules.d.ts +12 -9
  206. package/dist/apis/validation-rules.js +1 -1
  207. package/dist/apis/webhooks.cjs +8 -8
  208. package/dist/apis/webhooks.d.cts +18 -0
  209. package/dist/apis/webhooks.d.ts +12 -9
  210. package/dist/apis/webhooks.js +2 -2
  211. package/dist/apis/workflow-definition.cjs +6 -6
  212. package/dist/apis/workflow-definition.d.cts +18 -0
  213. package/dist/apis/workflow-definition.d.ts +12 -9
  214. package/dist/apis/workflow-definition.js +1 -1
  215. package/dist/apis/workflow.cjs +6 -6
  216. package/dist/apis/workflow.d.cts +18 -0
  217. package/dist/apis/workflow.d.ts +12 -9
  218. package/dist/apis/workflow.js +1 -1
  219. package/dist/app-34OBBTA4.js +7 -0
  220. package/dist/app-SSF545U7.cjs +7 -0
  221. package/dist/app-runtime-AFNM67YN.cjs +5 -0
  222. package/dist/{app-runtime-U7RGV7KT.js → app-runtime-DBUXZL6E.js} +1 -1
  223. package/dist/app.d--5n0FQQ4.d.cts +3757 -0
  224. package/dist/app.d--5n0FQQ4.d.ts +3757 -0
  225. package/dist/audit-logs.d-BRToFqeX.d.cts +287 -0
  226. package/dist/audit-logs.d-BRToFqeX.d.ts +287 -0
  227. package/dist/automation.d-Du6-uiz5.d.cts +5283 -0
  228. package/dist/automation.d-Du6-uiz5.d.ts +5283 -0
  229. package/dist/billing.d-Bs8Ku9qE.d.cts +993 -0
  230. package/dist/billing.d-Bs8Ku9qE.d.ts +993 -0
  231. package/dist/bin/cli.js +1 -1
  232. package/dist/blueprint-manifest.d-BPyzoR0X.d.cts +4343 -0
  233. package/dist/blueprint-manifest.d-BPyzoR0X.d.ts +4343 -0
  234. package/dist/calendar.d-BEjLDagH.d.cts +353 -0
  235. package/dist/calendar.d-BEjLDagH.d.ts +353 -0
  236. package/dist/chunk-5OBMZHRL.cjs +14 -0
  237. package/dist/{chunk-CD4OX2U6.cjs → chunk-C7GDYBXX.cjs} +9 -9
  238. package/dist/{chunk-L66IX6GX.cjs → chunk-KMVJYNLB.cjs} +1 -1
  239. package/dist/chunk-KYCVV2XE.cjs +14 -0
  240. package/dist/chunk-RGO3LTAM.js +14 -0
  241. package/dist/{chunk-TSV242UN.js → chunk-WRD2XFHY.js} +9 -9
  242. package/dist/{chunk-LLZYRINH.js → chunk-Z4H2FZ2K.js} +1 -1
  243. package/dist/chunk-Z6HGUGXK.js +14 -0
  244. package/dist/configuration-hub.d-Cqaq2F-W.d.cts +478 -0
  245. package/dist/configuration-hub.d-Cqaq2F-W.d.ts +478 -0
  246. package/dist/consent.d-C2PROHhX.d.cts +265 -0
  247. package/dist/consent.d-C2PROHhX.d.ts +265 -0
  248. package/dist/customer-portal-5I7ZGQDU.cjs +7 -0
  249. package/dist/customer-portal-YL2YMPZL.js +7 -0
  250. package/dist/{customer-portal-runtime-PSM55KGU.js → customer-portal-runtime-N4NWQ67M.js} +1 -1
  251. package/dist/{customer-portal-runtime-DULJLR7F.cjs → customer-portal-runtime-OEXTSMSE.cjs} +2 -2
  252. package/dist/customer-portal.d-ChSEioI5.d.cts +17113 -0
  253. package/dist/customer-portal.d-ChSEioI5.d.ts +17113 -0
  254. package/dist/dashboard.d-CsGcA74I.d.cts +440 -0
  255. package/dist/dashboard.d-CsGcA74I.d.ts +440 -0
  256. package/dist/data-governance.d-BbZ466j5.d.cts +1178 -0
  257. package/dist/data-governance.d-BbZ466j5.d.ts +1178 -0
  258. package/dist/deduplication.d-D5GYddVu.d.cts +218 -0
  259. package/dist/deduplication.d-D5GYddVu.d.ts +218 -0
  260. package/dist/design.d-BRre8iLg.d.cts +2346 -0
  261. package/dist/design.d-BRre8iLg.d.ts +2346 -0
  262. package/dist/document.d-DN37pjdx.d.cts +648 -0
  263. package/dist/document.d-DN37pjdx.d.ts +648 -0
  264. package/dist/email-settings.d-B7Q_xT25.d.cts +2417 -0
  265. package/dist/email-settings.d-B7Q_xT25.d.ts +2417 -0
  266. package/dist/email-template.d-gtQkdaXM.d.cts +1188 -0
  267. package/dist/email-template.d-gtQkdaXM.d.ts +1188 -0
  268. package/dist/entity-SS36LQO6.cjs +7 -0
  269. package/dist/entity-Z4YWKDVG.js +7 -0
  270. package/dist/entity-mapping.d-DKSW3sfy.d.cts +1092 -0
  271. package/dist/entity-mapping.d-DKSW3sfy.d.ts +1092 -0
  272. package/dist/entity.d-fospShiN.d.cts +18544 -0
  273. package/dist/entity.d-fospShiN.d.ts +18544 -0
  274. package/dist/environments.d-BvqvN-PD.d.cts +382 -0
  275. package/dist/environments.d-BvqvN-PD.d.ts +382 -0
  276. package/dist/event-catalog.d-ENw6HO-w.d.cts +1511 -0
  277. package/dist/event-catalog.d-ENw6HO-w.d.ts +1511 -0
  278. package/dist/file.d-DcTJxjp7.d.cts +2992 -0
  279. package/dist/file.d-DcTJxjp7.d.ts +2992 -0
  280. package/dist/iban.d-BwdiGbxi.d.cts +70 -0
  281. package/dist/iban.d-BwdiGbxi.d.ts +70 -0
  282. package/dist/index.cjs +14 -14
  283. package/dist/index.d.cts +182 -0
  284. package/dist/index.d.ts +182 -12
  285. package/dist/index.js +4 -4
  286. package/dist/integration-toolkit.d-Ry-KC9ow.d.cts +5796 -0
  287. package/dist/integration-toolkit.d-Ry-KC9ow.d.ts +5796 -0
  288. package/dist/journey.d-ClXO0xK8.d.cts +1931 -0
  289. package/dist/journey.d-ClXO0xK8.d.ts +1931 -0
  290. package/dist/{js-yaml-UPZKYVRY.js → js-yaml-DLCVPJ7G.js} +17 -15
  291. package/dist/kanban.d-BHnSRCYW.d.cts +760 -0
  292. package/dist/kanban.d-BHnSRCYW.d.ts +760 -0
  293. package/dist/message.d-B5UuSqgw.d.cts +3811 -0
  294. package/dist/message.d-B5UuSqgw.d.ts +3811 -0
  295. package/dist/metering.d-DvtPv7wk.d.cts +1841 -0
  296. package/dist/metering.d-DvtPv7wk.d.ts +1841 -0
  297. package/dist/notes-K2IIFCX3.cjs +7 -0
  298. package/dist/notes-Q7JGS7O3.js +7 -0
  299. package/dist/notes.d-BcV_m5fe.d.cts +1068 -0
  300. package/dist/notes.d-BcV_m5fe.d.ts +1068 -0
  301. package/dist/notification.d-BfBL3lga.d.cts +1147 -0
  302. package/dist/notification.d-BfBL3lga.d.ts +1147 -0
  303. package/dist/organization.d-DqwnNxMg.d.cts +1271 -0
  304. package/dist/organization.d-DqwnNxMg.d.ts +1271 -0
  305. package/dist/partner-directory.d-BCIjHoGs.d.cts +2337 -0
  306. package/dist/partner-directory.d-BCIjHoGs.d.ts +2337 -0
  307. package/dist/permissions.d-l6AT8SYP.d.cts +1279 -0
  308. package/dist/permissions.d-l6AT8SYP.d.ts +1279 -0
  309. package/dist/{pricing-XAET4G7T.cjs → pricing-FODHQFCB.cjs} +1 -1
  310. package/dist/{pricing-G67CH3XH.js → pricing-XRIDVZFC.js} +1 -1
  311. package/dist/pricing-tier.d-Cg0jl6n_.d.cts +81 -0
  312. package/dist/pricing-tier.d-Cg0jl6n_.d.ts +81 -0
  313. package/dist/pricing.d-BHpMU4KU.d.cts +12255 -0
  314. package/dist/pricing.d-BHpMU4KU.d.ts +12255 -0
  315. package/dist/purpose.d-CbIYfTua.d.cts +372 -0
  316. package/dist/purpose.d-CbIYfTua.d.ts +372 -0
  317. package/dist/query.d-Cmp78IhZ.d.cts +2375 -0
  318. package/dist/query.d-Cmp78IhZ.d.ts +2375 -0
  319. package/dist/sandbox.d-BdbOFzDu.d.cts +465 -0
  320. package/dist/sandbox.d-BdbOFzDu.d.ts +465 -0
  321. package/dist/sharing.d-sOXq-gtz.d.cts +571 -0
  322. package/dist/sharing.d-sOXq-gtz.d.ts +571 -0
  323. package/dist/submission.d-BamwfhXw.d.cts +469 -0
  324. package/dist/submission.d-BamwfhXw.d.ts +469 -0
  325. package/dist/targeting.d-BNmcVsNS.d.cts +2057 -0
  326. package/dist/targeting.d-BNmcVsNS.d.ts +2057 -0
  327. package/dist/template-variables.d-Ble9TSBa.d.cts +1320 -0
  328. package/dist/template-variables.d-Ble9TSBa.d.ts +1320 -0
  329. package/dist/types-ChU9Acbv.d.cts +37 -0
  330. package/dist/types-ChU9Acbv.d.ts +37 -0
  331. package/dist/user.d-D18fe97W.d.cts +2270 -0
  332. package/dist/user.d-D18fe97W.d.ts +2270 -0
  333. package/dist/validation-rules.d-Db5c5zTf.d.cts +807 -0
  334. package/dist/validation-rules.d-Db5c5zTf.d.ts +807 -0
  335. package/dist/webhooks-NZ3TM3AY.cjs +7 -0
  336. package/dist/webhooks-XLBUXXCS.js +7 -0
  337. package/dist/{webhooks-runtime-EBM4M3SU.cjs → webhooks-runtime-QVAFNBDW.cjs} +2 -2
  338. package/dist/{webhooks-runtime-XCQYIGQK.js → webhooks-runtime-UYTPQQVG.js} +1 -1
  339. package/dist/webhooks.d-D79qib9f.d.cts +1366 -0
  340. package/dist/webhooks.d-D79qib9f.d.ts +1366 -0
  341. package/dist/workflow-definition.d-DOeb0KVV.d.cts +1922 -0
  342. package/dist/workflow-definition.d-DOeb0KVV.d.ts +1922 -0
  343. package/dist/workflow.d-CMSKt8oN.d.cts +3151 -0
  344. package/dist/workflow.d-CMSKt8oN.d.ts +3151 -0
  345. package/docs/app.md +244 -9
  346. package/docs/customer-portal.md +340 -113
  347. package/docs/entity.md +65 -0
  348. package/docs/notes.md +19 -12
  349. package/docs/pricing.md +3 -1
  350. package/docs/webhooks.md +49 -0
  351. package/package.json +1 -1
  352. package/dist/apis/_registry.d.ts +0 -8
  353. package/dist/app-5KSVSKDU.js +0 -7
  354. package/dist/app-PL3IOROO.cjs +0 -7
  355. package/dist/app-runtime-SSNHSBR7.cjs +0 -5
  356. package/dist/authorize.d.ts +0 -3
  357. package/dist/bin/cli.d.ts +0 -1
  358. package/dist/chunk-2MMSXUOL.cjs +0 -14
  359. package/dist/chunk-A7AAVJGM.js +0 -14
  360. package/dist/chunk-GVNT76UU.js +0 -14
  361. package/dist/chunk-HHMXS5NC.cjs +0 -14
  362. package/dist/client-factory.d.ts +0 -9
  363. package/dist/client-map.d.ts +0 -102
  364. package/dist/compact.d.ts +0 -22
  365. package/dist/customer-portal-5LMHNBMD.cjs +0 -7
  366. package/dist/customer-portal-RZACUF4N.js +0 -7
  367. package/dist/entity-H6ESUH3Y.js +0 -7
  368. package/dist/entity-ZVDKWQSF.cjs +0 -7
  369. package/dist/help.d.ts +0 -12
  370. package/dist/large-response.d.ts +0 -9
  371. package/dist/notes-3AO5GXIT.js +0 -7
  372. package/dist/notes-MPWOQC5J.cjs +0 -7
  373. package/dist/openapi.d.ts +0 -12
  374. package/dist/overrides.d.ts +0 -9
  375. package/dist/proxy.d.ts +0 -14
  376. package/dist/registry.d.ts +0 -19
  377. package/dist/retry.d.ts +0 -11
  378. package/dist/sdk.d.ts +0 -29
  379. package/dist/types.d.ts +0 -53
  380. package/dist/webhooks-H3RT33BF.cjs +0 -7
  381. package/dist/webhooks-RTOU3MS5.js +0 -7
@@ -0,0 +1,3151 @@
1
+ import { OpenAPIClient, Parameters, AxiosRequestConfig, OperationResponse, UnknownParamsObject } from 'openapi-client-axios';
2
+
3
+ /* Auto-copied from workflow-client */
4
+
5
+
6
+ declare namespace Components {
7
+ namespace Parameters {
8
+ export type ExecutionIdParam = string;
9
+ export type PhaseIdParam = string;
10
+ export type ScheduleIdParam = string;
11
+ export type SoftDeleteParam = boolean;
12
+ export type TaskIdParam = string;
13
+ }
14
+ export interface PathParameters {
15
+ ExecutionIdParam?: Parameters.ExecutionIdParam;
16
+ TaskIdParam?: Parameters.TaskIdParam;
17
+ PhaseIdParam?: Parameters.PhaseIdParam;
18
+ ScheduleIdParam?: Parameters.ScheduleIdParam;
19
+ }
20
+ export interface QueryParameters {
21
+ SoftDeleteParam?: Parameters.SoftDeleteParam;
22
+ }
23
+ namespace Schemas {
24
+ export type ActionSchedule = ImmediateSchedule | DelayedSchedule | RelativeSchedule;
25
+ export interface AddTaskReq {
26
+ /**
27
+ * Source node id for the edge to this task
28
+ */
29
+ previous_task_id: string; // uuid
30
+ /**
31
+ * Target node id for the edge from this task
32
+ */
33
+ next_task_id: string; // uuid
34
+ task: {
35
+ /**
36
+ * Id of the task
37
+ */
38
+ id?: string; // uuid
39
+ name: string;
40
+ status?: /**
41
+ * **Note**: "UNASSIGNED" and "ASSIGNED" are deprecated and will be removed in a future version. Please use "PENDING" instead. Status values for workflow execution steps/tasks:
42
+ * - **UNASSIGNED**: Step has not been assigned to any user (deprecated - use PENDING instead)
43
+ * - **ASSIGNED**: Step has been assigned to one or more users (deprecated - use PENDING instead)
44
+ * - **PENDING**: Step/Task is waiting to be started by assigned users or is ready for execution
45
+ * - **IN_PROGRESS**: Step/Task is currently being worked on by a user
46
+ * - **COMPLETED**: Step/Task has been finished successfully
47
+ * - **SKIPPED**: Step/Task was intentionally bypassed and will not be executed
48
+ * - **SCHEDULED**: Task is scheduled to run at a specific time in the future
49
+ * - **CONDITION_PENDING**: Task is waiting for certain conditions to be met before it can proceed
50
+ * - **WAITING_FOR_CONFIRMATION**: Step/Task is paused and waiting for user confirmation via an external input (e.g., link in email) before proceeding.
51
+ * - **ON_HOLD**: Step/Task is temporarily paused and cannot proceed until manually resumed
52
+ * - **FAILED**: Task encountered an error and could not be completed. Mainly for automation tasks.
53
+ *
54
+ */
55
+ StepStatus;
56
+ /**
57
+ * example:
58
+ * 2021-04-27T12:00:00.000Z
59
+ */
60
+ due_date?: string;
61
+ due_date_config?: /* Set due date for the task based on a dynamic condition */ DueDateConfig;
62
+ assigned_to?: /* The user ids or variable assignments */ Assignees;
63
+ /**
64
+ * flag for controlling enabled/disabled state of the task
65
+ */
66
+ enabled?: boolean;
67
+ automation_config?: AutomationInfo;
68
+ phase_id?: string;
69
+ task_type?: TaskType;
70
+ };
71
+ }
72
+ /**
73
+ * Configuration for AI Agent to run
74
+ */
75
+ export interface AgentConfig {
76
+ [name: string]: any;
77
+ /**
78
+ * Id of the configured AI Agent to run
79
+ */
80
+ agent_id: string;
81
+ /**
82
+ * Parameters to customize the AI Agent behavior
83
+ */
84
+ parameters?: {
85
+ [key: string]: any;
86
+ };
87
+ }
88
+ export interface AgentExecutionInfo {
89
+ /**
90
+ * Id of the agent execution started by this task
91
+ */
92
+ execution_id?: string;
93
+ /**
94
+ * Status of the agent execution, when it already ran
95
+ */
96
+ execution_status?: string;
97
+ error_reason?: string;
98
+ }
99
+ export interface AiAgentTask {
100
+ id: TaskId;
101
+ template_id: string;
102
+ name: string;
103
+ description?: /* Longer information regarding Task */ StepDescription;
104
+ status: /**
105
+ * **Note**: "UNASSIGNED" and "ASSIGNED" are deprecated and will be removed in a future version. Please use "PENDING" instead. Status values for workflow execution steps/tasks:
106
+ * - **UNASSIGNED**: Step has not been assigned to any user (deprecated - use PENDING instead)
107
+ * - **ASSIGNED**: Step has been assigned to one or more users (deprecated - use PENDING instead)
108
+ * - **PENDING**: Step/Task is waiting to be started by assigned users or is ready for execution
109
+ * - **IN_PROGRESS**: Step/Task is currently being worked on by a user
110
+ * - **COMPLETED**: Step/Task has been finished successfully
111
+ * - **SKIPPED**: Step/Task was intentionally bypassed and will not be executed
112
+ * - **SCHEDULED**: Task is scheduled to run at a specific time in the future
113
+ * - **CONDITION_PENDING**: Task is waiting for certain conditions to be met before it can proceed
114
+ * - **WAITING_FOR_CONFIRMATION**: Step/Task is paused and waiting for user confirmation via an external input (e.g., link in email) before proceeding.
115
+ * - **ON_HOLD**: Step/Task is temporarily paused and cannot proceed until manually resumed
116
+ * - **FAILED**: Task encountered an error and could not be completed. Mainly for automation tasks.
117
+ *
118
+ */
119
+ StepStatus;
120
+ journey?: StepJourney;
121
+ /**
122
+ * example:
123
+ * 2021-04-27T12:00:00.000Z
124
+ */
125
+ due_date?: string;
126
+ due_date_config?: /* Set due date for the task based on a dynamic condition */ DueDateConfig;
127
+ /**
128
+ * requirements that need to be fulfilled in order to enable the task while flow instances are running
129
+ */
130
+ requirements?: /* describe the requirement for a task to be enabled */ EnableRequirement[];
131
+ assigned_to?: /* The user ids or variable assignments */ Assignees;
132
+ analytics: AnalyticsInfo;
133
+ /**
134
+ * Time when the task was created
135
+ */
136
+ created_at?: string; // date-time
137
+ /**
138
+ * Last Update timestamp
139
+ */
140
+ updated_at?: string; // date-time
141
+ /**
142
+ * Flag to indicate if the task was created manually
143
+ */
144
+ manually_created?: boolean;
145
+ /**
146
+ * enabled flag results from calculating the requirements
147
+ */
148
+ enabled: boolean;
149
+ ecp?: /* Details regarding ECP for the workflow step */ ECPDetails;
150
+ installer?: /* Details regarding ECP for the workflow step */ ECPDetails;
151
+ partner?: /* Details regarding partner for the workflow step */ PartnerDetails;
152
+ /**
153
+ * Taxonomy ids that are associated with this workflow and used for filtering
154
+ */
155
+ taxonomies?: string[];
156
+ phase_id?: string;
157
+ task_type: TaskType;
158
+ agent_config?: /* Configuration for AI Agent to run */ AgentConfig;
159
+ loop_config?: /* Information about loop iterations, when task is part of a loop branch */ LoopInfo;
160
+ agent_execution?: AgentExecutionInfo;
161
+ /**
162
+ * ID of the agent execution, used for tracking status updates. This is needed as a separate field to allow indexing.
163
+ */
164
+ agent_execution_id?: string;
165
+ }
166
+ export interface AnalyticsInfo {
167
+ started_at?: string; // date-time
168
+ in_progress_at?: string; // date-time
169
+ completed_at?: string; // date-time
170
+ /**
171
+ * Last updated timestamp of the status
172
+ */
173
+ status_updated_at?: string; // date-time
174
+ /**
175
+ * The user which moved the task/phase to IN_PROGRESS state.
176
+ */
177
+ in_progress_by?: /* The user id */ UserId;
178
+ /**
179
+ * The user which moved the task/phase to COMPLETED state.
180
+ */
181
+ completed_by?: /* The user id */ UserId;
182
+ /**
183
+ * The user which moved the task/phase to SKIPPED state.
184
+ */
185
+ skipped_by?: /* The user id */ UserId;
186
+ /**
187
+ * The user which moved the task/phase to ON_HOLD state.
188
+ */
189
+ on_hold_by?: /* The user id */ UserId;
190
+ }
191
+ /**
192
+ * The user ids or variable assignments
193
+ */
194
+ export type Assignees = (string | /* Represents a variable assignment with its expression and optional resolved value. Used for dynamic user assignments that get resolved during workflow execution. */ VariableAssignment)[];
195
+ /**
196
+ * Configuration for automation execution to run
197
+ */
198
+ export interface AutomationConfig {
199
+ /**
200
+ * Id of the configured automation to run
201
+ */
202
+ flowId: string;
203
+ /**
204
+ * Id of the automation execution which ran
205
+ */
206
+ executionId?: string;
207
+ /**
208
+ * Status of Automation Execution. Types can be found in Automation API
209
+ */
210
+ executionStatus?: string;
211
+ }
212
+ export interface AutomationInfo {
213
+ /**
214
+ * Id of the automation that should be run by this task
215
+ */
216
+ flow_id: string;
217
+ /**
218
+ * Id of the automation execution, when it already ran
219
+ */
220
+ execution_id?: string;
221
+ /**
222
+ * Status of the automation execution, when it already ran
223
+ */
224
+ execution_status?: string;
225
+ error_reason?: string;
226
+ input_context?: /**
227
+ * Optional. Source of the entity fed into this automation task. If omitted, the workflow's primary entity is used.
228
+ *
229
+ */
230
+ AutomationInputContext;
231
+ }
232
+ /**
233
+ * Optional. Source of the entity fed into this automation task. If omitted, the workflow's primary entity is used.
234
+ *
235
+ */
236
+ export interface AutomationInputContext {
237
+ /**
238
+ * `trigger` = workflow's primary (trigger) entity. `task` = entity produced by an upstream task in the graph.
239
+ *
240
+ */
241
+ source: "trigger" | "task";
242
+ /**
243
+ * Required when source is `task`. The id of the upstream task whose output entity should feed this task.
244
+ */
245
+ task_id?: string;
246
+ }
247
+ export interface AutomationTask {
248
+ id: TaskId;
249
+ template_id: string;
250
+ name: string;
251
+ description?: /* Longer information regarding Task */ StepDescription;
252
+ status: /**
253
+ * **Note**: "UNASSIGNED" and "ASSIGNED" are deprecated and will be removed in a future version. Please use "PENDING" instead. Status values for workflow execution steps/tasks:
254
+ * - **UNASSIGNED**: Step has not been assigned to any user (deprecated - use PENDING instead)
255
+ * - **ASSIGNED**: Step has been assigned to one or more users (deprecated - use PENDING instead)
256
+ * - **PENDING**: Step/Task is waiting to be started by assigned users or is ready for execution
257
+ * - **IN_PROGRESS**: Step/Task is currently being worked on by a user
258
+ * - **COMPLETED**: Step/Task has been finished successfully
259
+ * - **SKIPPED**: Step/Task was intentionally bypassed and will not be executed
260
+ * - **SCHEDULED**: Task is scheduled to run at a specific time in the future
261
+ * - **CONDITION_PENDING**: Task is waiting for certain conditions to be met before it can proceed
262
+ * - **WAITING_FOR_CONFIRMATION**: Step/Task is paused and waiting for user confirmation via an external input (e.g., link in email) before proceeding.
263
+ * - **ON_HOLD**: Step/Task is temporarily paused and cannot proceed until manually resumed
264
+ * - **FAILED**: Task encountered an error and could not be completed. Mainly for automation tasks.
265
+ *
266
+ */
267
+ StepStatus;
268
+ journey?: StepJourney;
269
+ /**
270
+ * example:
271
+ * 2021-04-27T12:00:00.000Z
272
+ */
273
+ due_date?: string;
274
+ due_date_config?: /* Set due date for the task based on a dynamic condition */ DueDateConfig;
275
+ /**
276
+ * requirements that need to be fulfilled in order to enable the task while flow instances are running
277
+ */
278
+ requirements?: /* describe the requirement for a task to be enabled */ EnableRequirement[];
279
+ assigned_to?: /* The user ids or variable assignments */ Assignees;
280
+ analytics: AnalyticsInfo;
281
+ /**
282
+ * Time when the task was created
283
+ */
284
+ created_at?: string; // date-time
285
+ /**
286
+ * Last Update timestamp
287
+ */
288
+ updated_at?: string; // date-time
289
+ /**
290
+ * Flag to indicate if the task was created manually
291
+ */
292
+ manually_created?: boolean;
293
+ /**
294
+ * enabled flag results from calculating the requirements
295
+ */
296
+ enabled: boolean;
297
+ ecp?: /* Details regarding ECP for the workflow step */ ECPDetails;
298
+ installer?: /* Details regarding ECP for the workflow step */ ECPDetails;
299
+ partner?: /* Details regarding partner for the workflow step */ PartnerDetails;
300
+ /**
301
+ * Taxonomy ids that are associated with this workflow and used for filtering
302
+ */
303
+ taxonomies?: string[];
304
+ phase_id?: string;
305
+ task_type: TaskType;
306
+ automation_config: AutomationInfo;
307
+ /**
308
+ * ID of the automation execution, used for tracking status updates.
309
+ */
310
+ automation_execution_id?: string;
311
+ trigger_mode?: TriggerMode;
312
+ schedule?: ActionSchedule;
313
+ loop_config?: /* Information about loop iterations, when task is part of a loop branch */ LoopInfo;
314
+ }
315
+ export interface ClosingReason {
316
+ id: string;
317
+ title: string;
318
+ }
319
+ export interface ClosingReasonResp {
320
+ reasons?: ClosingReason[];
321
+ }
322
+ export interface Condition {
323
+ id: /**
324
+ * A locally unique identifier for the condition
325
+ * example:
326
+ * abc123
327
+ */
328
+ ConditionId;
329
+ /**
330
+ * The name of the branch
331
+ * example:
332
+ * Branch 1
333
+ */
334
+ branch_name: string;
335
+ logical_operator: "AND" | "OR";
336
+ statements: Statement[];
337
+ /**
338
+ * Time when the condition was evaluated
339
+ */
340
+ evaluated_at?: string; // date-time
341
+ /**
342
+ * The result of evaluating this condition - true / false
343
+ */
344
+ is_met?: boolean;
345
+ }
346
+ /**
347
+ * A locally unique identifier for the condition
348
+ * example:
349
+ * abc123
350
+ */
351
+ export type ConditionId = string;
352
+ export interface CreateStepReq {
353
+ insertionIndex: number;
354
+ name: string;
355
+ /**
356
+ * Longer information regarding Task
357
+ */
358
+ description?: {
359
+ enabled: boolean;
360
+ value: string;
361
+ };
362
+ status?: /**
363
+ * **Note**: "UNASSIGNED" and "ASSIGNED" are deprecated and will be removed in a future version. Please use "PENDING" instead. Status values for workflow execution steps/tasks:
364
+ * - **UNASSIGNED**: Step has not been assigned to any user (deprecated - use PENDING instead)
365
+ * - **ASSIGNED**: Step has been assigned to one or more users (deprecated - use PENDING instead)
366
+ * - **PENDING**: Step/Task is waiting to be started by assigned users or is ready for execution
367
+ * - **IN_PROGRESS**: Step/Task is currently being worked on by a user
368
+ * - **COMPLETED**: Step/Task has been finished successfully
369
+ * - **SKIPPED**: Step/Task was intentionally bypassed and will not be executed
370
+ * - **SCHEDULED**: Task is scheduled to run at a specific time in the future
371
+ * - **CONDITION_PENDING**: Task is waiting for certain conditions to be met before it can proceed
372
+ * - **WAITING_FOR_CONFIRMATION**: Step/Task is paused and waiting for user confirmation via an external input (e.g., link in email) before proceeding.
373
+ * - **ON_HOLD**: Step/Task is temporarily paused and cannot proceed until manually resumed
374
+ * - **FAILED**: Task encountered an error and could not be completed. Mainly for automation tasks.
375
+ *
376
+ */
377
+ StepStatus;
378
+ sectionId?: string;
379
+ /**
380
+ * Manual / Automation step
381
+ */
382
+ executionType?: StepType;
383
+ /**
384
+ * Configuration for automated steps
385
+ */
386
+ automationConfig?: /* Configuration for automation execution to run */ AutomationConfig;
387
+ }
388
+ export interface DecisionTask {
389
+ id: TaskId;
390
+ template_id: string;
391
+ name: string;
392
+ description?: /* Longer information regarding Task */ StepDescription;
393
+ status: /**
394
+ * **Note**: "UNASSIGNED" and "ASSIGNED" are deprecated and will be removed in a future version. Please use "PENDING" instead. Status values for workflow execution steps/tasks:
395
+ * - **UNASSIGNED**: Step has not been assigned to any user (deprecated - use PENDING instead)
396
+ * - **ASSIGNED**: Step has been assigned to one or more users (deprecated - use PENDING instead)
397
+ * - **PENDING**: Step/Task is waiting to be started by assigned users or is ready for execution
398
+ * - **IN_PROGRESS**: Step/Task is currently being worked on by a user
399
+ * - **COMPLETED**: Step/Task has been finished successfully
400
+ * - **SKIPPED**: Step/Task was intentionally bypassed and will not be executed
401
+ * - **SCHEDULED**: Task is scheduled to run at a specific time in the future
402
+ * - **CONDITION_PENDING**: Task is waiting for certain conditions to be met before it can proceed
403
+ * - **WAITING_FOR_CONFIRMATION**: Step/Task is paused and waiting for user confirmation via an external input (e.g., link in email) before proceeding.
404
+ * - **ON_HOLD**: Step/Task is temporarily paused and cannot proceed until manually resumed
405
+ * - **FAILED**: Task encountered an error and could not be completed. Mainly for automation tasks.
406
+ *
407
+ */
408
+ StepStatus;
409
+ journey?: StepJourney;
410
+ /**
411
+ * example:
412
+ * 2021-04-27T12:00:00.000Z
413
+ */
414
+ due_date?: string;
415
+ due_date_config?: /* Set due date for the task based on a dynamic condition */ DueDateConfig;
416
+ /**
417
+ * requirements that need to be fulfilled in order to enable the task while flow instances are running
418
+ */
419
+ requirements?: /* describe the requirement for a task to be enabled */ EnableRequirement[];
420
+ assigned_to?: /* The user ids or variable assignments */ Assignees;
421
+ analytics: AnalyticsInfo;
422
+ /**
423
+ * Time when the task was created
424
+ */
425
+ created_at?: string; // date-time
426
+ /**
427
+ * Last Update timestamp
428
+ */
429
+ updated_at?: string; // date-time
430
+ /**
431
+ * Flag to indicate if the task was created manually
432
+ */
433
+ manually_created?: boolean;
434
+ /**
435
+ * enabled flag results from calculating the requirements
436
+ */
437
+ enabled: boolean;
438
+ ecp?: /* Details regarding ECP for the workflow step */ ECPDetails;
439
+ installer?: /* Details regarding ECP for the workflow step */ ECPDetails;
440
+ partner?: /* Details regarding partner for the workflow step */ PartnerDetails;
441
+ /**
442
+ * Taxonomy ids that are associated with this workflow and used for filtering
443
+ */
444
+ taxonomies?: string[];
445
+ phase_id?: string;
446
+ task_type: TaskType;
447
+ trigger_mode: TriggerMode;
448
+ conditions: Condition[];
449
+ /**
450
+ * When true, all branches with met conditions execute in parallel. When false, only the first branch with a met condition is executed. Defaults to true for backwards compatibility.
451
+ */
452
+ allow_parallel_execution?: boolean;
453
+ schedule?: DelayedSchedule | RelativeSchedule;
454
+ loop_config?: LoopConfig;
455
+ }
456
+ export interface DelayedSchedule {
457
+ mode: "delayed";
458
+ duration: number;
459
+ unit: TimeUnit;
460
+ /**
461
+ * The id of the created schedule
462
+ */
463
+ schedule_id?: string;
464
+ }
465
+ /**
466
+ * Set due date for the task based on a dynamic condition
467
+ */
468
+ export interface DueDateConfig {
469
+ duration: number;
470
+ unit: TimeUnit;
471
+ type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED";
472
+ task_id?: string;
473
+ phase_id?: string;
474
+ }
475
+ /**
476
+ * set a Duedate for a step then a specific
477
+ */
478
+ export interface DynamicDueDate {
479
+ numberOfUnits: number;
480
+ timePeriod: "minutes" | "hours" | "days" | "weeks" | "months";
481
+ actionTypeCondition?: "WORKFLOW_STARTED" | "STEP_CLOSED" | "PHASE_FINISHED";
482
+ stepId?: string;
483
+ phaseId?: string;
484
+ }
485
+ /**
486
+ * Details regarding ECP for the workflow step
487
+ */
488
+ export interface ECPDetails {
489
+ enabled?: boolean;
490
+ label?: string;
491
+ description?: string;
492
+ journey?: StepJourney;
493
+ }
494
+ export interface Edge {
495
+ id: string;
496
+ from_id: TaskId;
497
+ to_id: TaskId;
498
+ condition_id?: /**
499
+ * A locally unique identifier for the condition
500
+ * example:
501
+ * abc123
502
+ */
503
+ ConditionId;
504
+ /**
505
+ * Indicates a default case for a decision task. Only decision task edges can have this field and the flow advances using this edge if no conditions are met.
506
+ */
507
+ none_met?: boolean;
508
+ }
509
+ /**
510
+ * describe the requirement for a task to be enabled
511
+ */
512
+ export interface EnableRequirement {
513
+ /**
514
+ * The template_id of the task that this requirement points to
515
+ */
516
+ task_id?: string;
517
+ /**
518
+ * The template_id of the phase that this requirement points to
519
+ */
520
+ phase_id?: string;
521
+ when: "TASK_FINISHED" | "PHASE_FINISHED";
522
+ }
523
+ export interface EntityRef {
524
+ entity_id?: string;
525
+ entity_schema?: string;
526
+ /**
527
+ * Flag to indicate if the entity is primary and should be used for evaluating the conditions of the tasks
528
+ */
529
+ is_primary?: boolean;
530
+ }
531
+ /**
532
+ * example:
533
+ * {
534
+ * "trigger": {
535
+ * "event": "FlowStarted"
536
+ * },
537
+ * "target": {
538
+ * "entitySchema": "opportunity",
539
+ * "entityAttribute": "title"
540
+ * },
541
+ * "value": {
542
+ * "source": "workflow_name"
543
+ * }
544
+ * }
545
+ */
546
+ export interface EntitySync {
547
+ /**
548
+ * Trigger configuration that determines when entity sync occurs.
549
+ * Contains the event type and optional filter to target specific tasks/phases.
550
+ *
551
+ */
552
+ trigger: {
553
+ /**
554
+ * Event or condition that triggers the entity sync.
555
+ * Direct triggers match EventBridge event names (PascalCase).
556
+ * Status triggers are deduced from event + entity status combination.
557
+ *
558
+ */
559
+ event: "FlowStarted" | "FlowCompleted" | "FlowCancelled" | "FlowReopened" | "FlowDeleted" | "FlowAssigned" | "FlowDueDateChanged" | "FlowContextsChanged" | "TaskUpdated" | "CurrTaskChanged" | "TaskCompleted" | "TaskSkipped" | "TaskMarkedInProgress" | "TaskMarkedOnHold" | "PhaseUpdated" | "PhaseCompleted" | "PhaseSkipped" | "PhaseMarkedInProgress";
560
+ /**
561
+ * Optional filter to target specific tasks or phases.
562
+ * Specify either task_template_id OR phase_template_id (mutually exclusive).
563
+ * If omitted, trigger applies to all tasks/phases.
564
+ *
565
+ */
566
+ filter?: {
567
+ /**
568
+ * Target a specific task by its template ID (stable across executions)
569
+ */
570
+ task_template_id?: string;
571
+ /**
572
+ * Target a specific phase by its template ID (stable across executions)
573
+ */
574
+ phase_template_id?: string;
575
+ };
576
+ };
577
+ value: {
578
+ source: "workflow_name" | "workflow_status" | "workflow_assigned_to" | "task_name" | "task_status" | "task_assigned_to" | "phase_name" | "phase_status" | "phase_assigned_to" | "custom_value";
579
+ value?: string;
580
+ };
581
+ target: {
582
+ /**
583
+ * example:
584
+ * opportunity
585
+ */
586
+ entitySchema: string;
587
+ /**
588
+ * example:
589
+ * title
590
+ */
591
+ entityAttribute: string;
592
+ };
593
+ }
594
+ export interface ErrorResp {
595
+ message?: string;
596
+ }
597
+ export interface EvaluationSource {
598
+ /**
599
+ * The id of the action or trigger
600
+ */
601
+ id?: string;
602
+ origin?: "trigger" | "action";
603
+ origin_type?: "entity" | "workflow" | "journey_block";
604
+ schema?: string;
605
+ attribute?: string;
606
+ 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";
607
+ attribute_repeatable?: boolean;
608
+ attribute_operation?: "all" | "updated" | "added" | "deleted";
609
+ /**
610
+ * For complex attribute types, specifies which sub-field to extract (e.g., 'address', 'name', 'email_type')
611
+ */
612
+ attribute_sub_field?: string;
613
+ /**
614
+ * Offset to apply to the source date value before comparison (e.g., +18 years for age check, +30 days for expiry)
615
+ */
616
+ date_offset?: {
617
+ /**
618
+ * Number of units to offset
619
+ */
620
+ amount?: number;
621
+ /**
622
+ * Unit of the offset
623
+ */
624
+ unit?: "days" | "months" | "years";
625
+ };
626
+ }
627
+ export interface ExecutionPaginationDynamo {
628
+ orgId?: string;
629
+ creationTime?: string;
630
+ }
631
+ export interface Flow {
632
+ flow: (/* A group of Steps that define the progress of the Workflow */ Section | Step)[];
633
+ }
634
+ export interface FlowClosingReason {
635
+ selected_reasons?: ClosingReason[];
636
+ configured_reasons?: ClosingReason[];
637
+ extra_description?: string;
638
+ }
639
+ export type FlowContext = EntityRef;
640
+ export interface FlowExecution {
641
+ id: FlowExecutionId;
642
+ flow_template_id: FlowTemplateId;
643
+ org_id: string;
644
+ name: string;
645
+ /**
646
+ * Creation timestamp which will double as started time as well
647
+ */
648
+ created_at: string;
649
+ /**
650
+ * Last Update timestamp
651
+ */
652
+ updated_at: string;
653
+ /**
654
+ * Due date for finishing the workflow
655
+ */
656
+ due_date?: string;
657
+ due_date_config?: /* Set due date for the task based on a dynamic condition */ DueDateConfig;
658
+ status: WorkflowStatus;
659
+ assigned_to?: /* The user ids or variable assignments */ Assignees;
660
+ analytics: {
661
+ /**
662
+ * Timestamp when the flow execution started
663
+ */
664
+ started_at?: string;
665
+ /**
666
+ * Timestamp when the flow execution was completed
667
+ */
668
+ completed_at?: string;
669
+ /**
670
+ * Timestamp when the flow execution was closed
671
+ */
672
+ closed_at?: string;
673
+ /**
674
+ * User who started the flow execution.
675
+ */
676
+ started_by?: string;
677
+ /**
678
+ * User who closed the flow execution
679
+ */
680
+ closed_by?: string;
681
+ };
682
+ contexts: FlowContext[];
683
+ crt_tasks: {
684
+ id?: TaskId;
685
+ }[];
686
+ phases?: Phase[];
687
+ tasks: Task[];
688
+ edges: Edge[];
689
+ /**
690
+ * [Internal] Tracks the chain of automation-originated executions to prevent infinite loops. This is an internal property and should not be used by external consumers.
691
+ */
692
+ _execution_chain?: {
693
+ /**
694
+ * ID of the parent flow execution that triggered this execution via automation
695
+ */
696
+ parent_execution_id?: string;
697
+ /**
698
+ * ID of the automation task in the parent execution that triggered this
699
+ */
700
+ parent_task_id?: string;
701
+ /**
702
+ * The depth in the execution chain (0 for manual triggers, 1+ for automation-triggered)
703
+ */
704
+ depth?: number;
705
+ };
706
+ closing_reason?: FlowClosingReason;
707
+ /**
708
+ * Indicates whether this flow execution is available for End Customer Portal or not. By default it's not.
709
+ */
710
+ available_in_ecp?: boolean;
711
+ entity_sync?: /**
712
+ * example:
713
+ * {
714
+ * "trigger": {
715
+ * "event": "FlowStarted"
716
+ * },
717
+ * "target": {
718
+ * "entitySchema": "opportunity",
719
+ * "entityAttribute": "title"
720
+ * },
721
+ * "value": {
722
+ * "source": "workflow_name"
723
+ * }
724
+ * }
725
+ */
726
+ EntitySync[];
727
+ /**
728
+ * Taxonomy ids (both Labels and Purposes) that are associated with this workflow and used for filtering
729
+ */
730
+ taxonomies?: string[];
731
+ trigger: FlowTrigger;
732
+ /**
733
+ * Indicates whether only a single closing reason can be selected when closing the flow execution
734
+ */
735
+ singleClosingReasonSelection?: boolean;
736
+ }
737
+ export type FlowExecutionId = string;
738
+ export interface FlowSlim {
739
+ flow: (/* A group of Steps that define the progress of the Workflow */ Section | Step)[];
740
+ }
741
+ export type FlowTemplateId = string;
742
+ export interface FlowTrigger {
743
+ type?: TriggerType;
744
+ automation_config?: AutomationInfo;
745
+ }
746
+ export interface ImmediateSchedule {
747
+ mode: "immediate";
748
+ }
749
+ export type ItemType = "STEP" | "SECTION";
750
+ export interface LastEvaluatedKey {
751
+ orgId?: string;
752
+ creationTime?: string;
753
+ }
754
+ export interface LoopConfig {
755
+ /**
756
+ * The id of the branch that will be looped
757
+ */
758
+ loop_branch_id: string;
759
+ /**
760
+ * The id of the branch that will be used to exit the loop
761
+ */
762
+ exit_branch_id: string;
763
+ /**
764
+ * Maximum number of iterations for the loop branch
765
+ */
766
+ max_iterations: number;
767
+ /**
768
+ * Current number of iterations for the loop branch
769
+ */
770
+ crt_iterations?: number;
771
+ }
772
+ /**
773
+ * Information about loop iterations, when task is part of a loop branch
774
+ */
775
+ export interface LoopInfo {
776
+ /**
777
+ * Maximum number of iterations for the loop branch
778
+ */
779
+ max_iterations: number;
780
+ /**
781
+ * Current number of iterations for the loop branch
782
+ */
783
+ crt_iterations?: number;
784
+ }
785
+ export interface ManualTask {
786
+ id: TaskId;
787
+ template_id: string;
788
+ name: string;
789
+ description?: /* Longer information regarding Task */ StepDescription;
790
+ status: /**
791
+ * **Note**: "UNASSIGNED" and "ASSIGNED" are deprecated and will be removed in a future version. Please use "PENDING" instead. Status values for workflow execution steps/tasks:
792
+ * - **UNASSIGNED**: Step has not been assigned to any user (deprecated - use PENDING instead)
793
+ * - **ASSIGNED**: Step has been assigned to one or more users (deprecated - use PENDING instead)
794
+ * - **PENDING**: Step/Task is waiting to be started by assigned users or is ready for execution
795
+ * - **IN_PROGRESS**: Step/Task is currently being worked on by a user
796
+ * - **COMPLETED**: Step/Task has been finished successfully
797
+ * - **SKIPPED**: Step/Task was intentionally bypassed and will not be executed
798
+ * - **SCHEDULED**: Task is scheduled to run at a specific time in the future
799
+ * - **CONDITION_PENDING**: Task is waiting for certain conditions to be met before it can proceed
800
+ * - **WAITING_FOR_CONFIRMATION**: Step/Task is paused and waiting for user confirmation via an external input (e.g., link in email) before proceeding.
801
+ * - **ON_HOLD**: Step/Task is temporarily paused and cannot proceed until manually resumed
802
+ * - **FAILED**: Task encountered an error and could not be completed. Mainly for automation tasks.
803
+ *
804
+ */
805
+ StepStatus;
806
+ journey?: StepJourney;
807
+ /**
808
+ * example:
809
+ * 2021-04-27T12:00:00.000Z
810
+ */
811
+ due_date?: string;
812
+ due_date_config?: /* Set due date for the task based on a dynamic condition */ DueDateConfig;
813
+ /**
814
+ * requirements that need to be fulfilled in order to enable the task while flow instances are running
815
+ */
816
+ requirements?: /* describe the requirement for a task to be enabled */ EnableRequirement[];
817
+ assigned_to?: /* The user ids or variable assignments */ Assignees;
818
+ analytics: AnalyticsInfo;
819
+ /**
820
+ * Time when the task was created
821
+ */
822
+ created_at?: string; // date-time
823
+ /**
824
+ * Last Update timestamp
825
+ */
826
+ updated_at?: string; // date-time
827
+ /**
828
+ * Flag to indicate if the task was created manually
829
+ */
830
+ manually_created?: boolean;
831
+ /**
832
+ * enabled flag results from calculating the requirements
833
+ */
834
+ enabled: boolean;
835
+ ecp?: /* Details regarding ECP for the workflow step */ ECPDetails;
836
+ installer?: /* Details regarding ECP for the workflow step */ ECPDetails;
837
+ partner?: /* Details regarding partner for the workflow step */ PartnerDetails;
838
+ /**
839
+ * Taxonomy ids that are associated with this workflow and used for filtering
840
+ */
841
+ taxonomies?: string[];
842
+ phase_id?: string;
843
+ task_type: TaskType;
844
+ loop_config?: /* Information about loop iterations, when task is part of a loop branch */ LoopInfo;
845
+ }
846
+ export 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";
847
+ /**
848
+ * Details regarding partner for the workflow step
849
+ */
850
+ export interface PartnerDetails {
851
+ enabled?: boolean;
852
+ label?: string;
853
+ description?: string;
854
+ }
855
+ export interface PatchFlowReq {
856
+ status?: WorkflowStatus;
857
+ assigned_to?: /* The user ids or variable assignments */ Assignees;
858
+ closing_reason?: FlowClosingReason;
859
+ due_date?: string;
860
+ due_date_config?: /* Set due date for the task based on a dynamic condition */ DueDateConfig;
861
+ contexts?: FlowContext[];
862
+ }
863
+ export interface PatchPhaseReq {
864
+ name?: string;
865
+ /**
866
+ * example:
867
+ * 2021-04-27T12:00:00.000Z
868
+ */
869
+ due_date?: string;
870
+ due_date_config?: /* Set due date for the task based on a dynamic condition */ DueDateConfig;
871
+ assigned_to?: /* The user ids or variable assignments */ Assignees;
872
+ }
873
+ export interface PatchTaskReq {
874
+ name?: string;
875
+ status?: /**
876
+ * **Note**: "UNASSIGNED" and "ASSIGNED" are deprecated and will be removed in a future version. Please use "PENDING" instead. Status values for workflow execution steps/tasks:
877
+ * - **UNASSIGNED**: Step has not been assigned to any user (deprecated - use PENDING instead)
878
+ * - **ASSIGNED**: Step has been assigned to one or more users (deprecated - use PENDING instead)
879
+ * - **PENDING**: Step/Task is waiting to be started by assigned users or is ready for execution
880
+ * - **IN_PROGRESS**: Step/Task is currently being worked on by a user
881
+ * - **COMPLETED**: Step/Task has been finished successfully
882
+ * - **SKIPPED**: Step/Task was intentionally bypassed and will not be executed
883
+ * - **SCHEDULED**: Task is scheduled to run at a specific time in the future
884
+ * - **CONDITION_PENDING**: Task is waiting for certain conditions to be met before it can proceed
885
+ * - **WAITING_FOR_CONFIRMATION**: Step/Task is paused and waiting for user confirmation via an external input (e.g., link in email) before proceeding.
886
+ * - **ON_HOLD**: Step/Task is temporarily paused and cannot proceed until manually resumed
887
+ * - **FAILED**: Task encountered an error and could not be completed. Mainly for automation tasks.
888
+ *
889
+ */
890
+ StepStatus;
891
+ /**
892
+ * example:
893
+ * 2021-04-27T12:00:00.000Z
894
+ */
895
+ due_date?: string;
896
+ due_date_config?: /* Set due date for the task based on a dynamic condition */ DueDateConfig;
897
+ assigned_to?: /* The user ids or variable assignments */ Assignees;
898
+ /**
899
+ * flag for controlling enabled/disabled state of the task
900
+ */
901
+ enabled?: boolean;
902
+ automation_config?: AutomationInfo;
903
+ description?: /* Longer information regarding Task */ StepDescription;
904
+ ecp?: /* Details regarding ECP for the workflow step */ ECPDetails;
905
+ installer?: /* Details regarding ECP for the workflow step */ ECPDetails;
906
+ /**
907
+ * Partner-specific task details shown to partner org users viewing shared resources
908
+ */
909
+ partner?: /* Details regarding partner for the workflow step */ PartnerDetails;
910
+ /**
911
+ * Condition to evaluate as true for a decision task with a manual trigger mode
912
+ */
913
+ next_condition_id?: string;
914
+ /**
915
+ * When patching an already completed/skipped task that comes before the current task, this flag controls whether to revert the execution:
916
+ * - `true`: The patched task becomes the current task AND all succeeding tasks are reset to PENDING (full revert)
917
+ * - `false` or omitted (undefined): The task is updated but the current task does not change and no downstream tasks are affected
918
+ * This parameter is silently ignored when patching the current task or future tasks.
919
+ *
920
+ */
921
+ revert_execution?: boolean;
922
+ }
923
+ export interface Phase {
924
+ id: PhaseId;
925
+ template_id: string;
926
+ name: string;
927
+ status?: SectionStatus;
928
+ /**
929
+ * Last Update timestamp
930
+ */
931
+ updated_at?: string;
932
+ /**
933
+ * example:
934
+ * 2021-04-27T12:00:00.000Z
935
+ */
936
+ due_date?: string;
937
+ due_date_config?: /* Set due date for the task based on a dynamic condition */ DueDateConfig;
938
+ assigned_to?: /* The user ids or variable assignments */ Assignees;
939
+ analytics?: AnalyticsInfo;
940
+ /**
941
+ * Taxonomy ids that are associated with this workflow and used for filtering
942
+ */
943
+ taxonomies?: string[];
944
+ loop_config?: /* Information about loop iterations, when task is part of a loop branch */ LoopInfo;
945
+ }
946
+ export type PhaseId = string;
947
+ export interface PhaseInEntity {
948
+ phase_id?: string;
949
+ phase_name?: string;
950
+ phase_progress?: number;
951
+ phase_assignees?: string[];
952
+ }
953
+ export interface RelativeSchedule {
954
+ mode: "relative";
955
+ direction: "before" | "after";
956
+ duration: number;
957
+ unit: TimeUnit;
958
+ reference: {
959
+ /**
960
+ * The id of the entity / workflow / task, based on the origin of the schedule. For all_preceding_tasks_completed, use the sentinel value 'all_preceding_tasks_completed'.
961
+ */
962
+ id: string;
963
+ origin: "flow_started" | "task_completed" | "trigger_entity_attribute" | "all_preceding_tasks_completed";
964
+ /**
965
+ * The schema of the entity
966
+ */
967
+ schema?: string;
968
+ /**
969
+ * An entity attribute that identifies a date / datetime
970
+ */
971
+ attribute?: string;
972
+ };
973
+ /**
974
+ * The id of the created schedule
975
+ */
976
+ schedule_id?: string;
977
+ }
978
+ export interface SearchExecutionsReq {
979
+ name?: string;
980
+ status?: WorkflowStatus;
981
+ includeDoneWorkflows?: boolean;
982
+ assignedTo?: string;
983
+ sorting?: SearchSorting;
984
+ pagination?: ExecutionPaginationDynamo;
985
+ }
986
+ export interface SearchExecutionsResp {
987
+ executions: /**
988
+ * example:
989
+ * {
990
+ * "id": "8gja72h6kas6h",
991
+ * "name": "Lead Qualification",
992
+ * "trigger": "MANUAL",
993
+ * "status": "STARTED",
994
+ * "creationTime": "2021-04-27T12:01:13.000Z",
995
+ * "lastUpdateTime": "2021-04-27T12:01:13.000Z",
996
+ * "dueDate": "2021-04-27T12:01:13.000Z",
997
+ * "flow": [
998
+ * {
999
+ * "id": "sectionId1",
1000
+ * "definitionId": "section_definition_id_1",
1001
+ * "name": "Initial Information Gathering",
1002
+ * "type": "SECTION",
1003
+ * "steps": [
1004
+ * {
1005
+ * "id": "sada5641f3a21",
1006
+ * "definitionId": "step_definition_id_1",
1007
+ * "name": "Call client"
1008
+ * },
1009
+ * {
1010
+ * "id": "sada5641f3a22",
1011
+ * "definitionId": "step_definition_id_2",
1012
+ * "name": "Check product availability"
1013
+ * },
1014
+ * {
1015
+ * "id": "sada5641f3a23",
1016
+ * "definitionId": "step_definition_id_3",
1017
+ * "name": "Send email confirming contact with the client"
1018
+ * }
1019
+ * ]
1020
+ * },
1021
+ * {
1022
+ * "id": "firstLevelStepId1",
1023
+ * "definitionId": "step_definition_id_4",
1024
+ * "name": "Print and send catalog",
1025
+ * "type": "STEP"
1026
+ * }
1027
+ * ]
1028
+ * }
1029
+ */
1030
+ WorkflowExecutionSlim[];
1031
+ lastEvaluatedKey?: LastEvaluatedKey;
1032
+ }
1033
+ export interface SearchFlowsReq {
1034
+ entity_id: string;
1035
+ entity_schema: string;
1036
+ }
1037
+ export interface SearchPagination {
1038
+ from?: number;
1039
+ size?: number;
1040
+ }
1041
+ export type SearchSorting = "A_Z" | "Z_A" | "DUE_DATE_ASC" | "DUE_DATE_DESC" | "TRIGGER_DATE_ASC" | "TRIGGER_DATE_DESC";
1042
+ export interface SearchStepsReq {
1043
+ executionName?: string;
1044
+ stepName?: string;
1045
+ assignedTo?: number;
1046
+ includeDoneWorkflows?: boolean;
1047
+ manuallyCreated?: boolean;
1048
+ status?: "OPEN" | "COMPLETE" | "NEXT_OPEN_ITEM_IN_WORKFLOW";
1049
+ sorting?: SearchSorting;
1050
+ pagination?: SearchPagination;
1051
+ }
1052
+ export interface SearchStepsResp {
1053
+ /**
1054
+ * example:
1055
+ * 50
1056
+ */
1057
+ hits?: number;
1058
+ results?: {
1059
+ id: string;
1060
+ definitionId?: string;
1061
+ /**
1062
+ * This field is deprecated. It will be soon removed. Please use only id.
1063
+ */
1064
+ entityRefId?: string;
1065
+ name: string;
1066
+ description?: /* Longer information regarding Task */ StepDescription;
1067
+ type: ItemType;
1068
+ ecp?: /* Details regarding ECP for the workflow step */ ECPDetails;
1069
+ installer?: /* Details regarding ECP for the workflow step */ ECPDetails;
1070
+ partner?: /* Details regarding partner for the workflow step */ PartnerDetails;
1071
+ /**
1072
+ * enabled flag results from calculating the requirements
1073
+ */
1074
+ enabled?: boolean;
1075
+ requirements?: /* describe the requirement for step enablement */ StepRequirement[];
1076
+ executionType?: StepType;
1077
+ sectionId?: string;
1078
+ executionId: string;
1079
+ /**
1080
+ * This field is deprecated. Please use assignedTo
1081
+ */
1082
+ userIds?: number[];
1083
+ assignedTo?: string[];
1084
+ /**
1085
+ * The user which moved the step/task to the IN_PROGRESS state. The user should also be present in the assignedTo property of the step/task
1086
+ */
1087
+ assignedToInProgress?: string;
1088
+ /**
1089
+ * The user which moved the step/task to the ON_HOLD state. The user should also be present in the assignedTo property of the step/task
1090
+ */
1091
+ assignedToOnHold?: string;
1092
+ status?: /**
1093
+ * **Note**: "UNASSIGNED" and "ASSIGNED" are deprecated and will be removed in a future version. Please use "PENDING" instead. Status values for workflow execution steps/tasks:
1094
+ * - **UNASSIGNED**: Step has not been assigned to any user (deprecated - use PENDING instead)
1095
+ * - **ASSIGNED**: Step has been assigned to one or more users (deprecated - use PENDING instead)
1096
+ * - **PENDING**: Step/Task is waiting to be started by assigned users or is ready for execution
1097
+ * - **IN_PROGRESS**: Step/Task is currently being worked on by a user
1098
+ * - **COMPLETED**: Step/Task has been finished successfully
1099
+ * - **SKIPPED**: Step/Task was intentionally bypassed and will not be executed
1100
+ * - **SCHEDULED**: Task is scheduled to run at a specific time in the future
1101
+ * - **CONDITION_PENDING**: Task is waiting for certain conditions to be met before it can proceed
1102
+ * - **WAITING_FOR_CONFIRMATION**: Step/Task is paused and waiting for user confirmation via an external input (e.g., link in email) before proceeding.
1103
+ * - **ON_HOLD**: Step/Task is temporarily paused and cannot proceed until manually resumed
1104
+ * - **FAILED**: Task encountered an error and could not be completed. Mainly for automation tasks.
1105
+ *
1106
+ */
1107
+ StepStatus;
1108
+ created?: string;
1109
+ lastUpdated?: string;
1110
+ /**
1111
+ * Last updated timestamp of the status
1112
+ */
1113
+ statusLastUpdated?: string;
1114
+ startedTime?: string;
1115
+ completedTime?: string;
1116
+ dueDate?: string;
1117
+ dynamicDueDate?: /* set a Duedate for a step then a specific */ DynamicDueDate;
1118
+ manuallyCreated?: boolean;
1119
+ automationConfig?: /* Configuration for automation execution to run */ AutomationConfig;
1120
+ journey?: StepJourney;
1121
+ /**
1122
+ * Taxonomy ids (purposes in this case) that are associated with this step/task and used for filtering
1123
+ */
1124
+ taxonomies?: string[];
1125
+ executionName: string;
1126
+ executionStatus: WorkflowStatus;
1127
+ contexts?: {
1128
+ id: string;
1129
+ title: string;
1130
+ schema: string;
1131
+ }[];
1132
+ }[];
1133
+ }
1134
+ /**
1135
+ * A group of Steps that define the progress of the Workflow
1136
+ */
1137
+ export interface Section {
1138
+ id: string;
1139
+ definitionId?: string;
1140
+ /**
1141
+ * Name for this Section
1142
+ * example:
1143
+ * Lead Qualification
1144
+ */
1145
+ name: string;
1146
+ /**
1147
+ * This field is deprecated. Please use assignedTo
1148
+ */
1149
+ userIds?: number[];
1150
+ assignedTo?: string[];
1151
+ /**
1152
+ * example:
1153
+ * 2021-04-27T12:00:00.000Z
1154
+ */
1155
+ dueDate?: string;
1156
+ dynamicDueDate?: /* set a Duedate for a step then a specific */ DynamicDueDate;
1157
+ startedTime?: string;
1158
+ completedTime?: string;
1159
+ status?: SectionStatus;
1160
+ type: ItemType;
1161
+ steps: Step[];
1162
+ /**
1163
+ * Taxonomy ids (purposes in this case) that are associated with this section and used for filtering
1164
+ */
1165
+ taxonomies?: string[];
1166
+ }
1167
+ /**
1168
+ * A group of Steps that define the progress of the Workflow
1169
+ */
1170
+ export interface SectionSimplified {
1171
+ id: string;
1172
+ definitionId?: string;
1173
+ /**
1174
+ * Name for this Section
1175
+ * example:
1176
+ * Lead Qualification
1177
+ */
1178
+ name: string;
1179
+ type: ItemType;
1180
+ steps: StepSimplified[];
1181
+ assignedTo?: string[];
1182
+ }
1183
+ export type SectionStatus = "OPEN" | "IN_PROGRESS" | "COMPLETED";
1184
+ export interface StartFlowReq {
1185
+ flow_template_id: string;
1186
+ trigger?: FlowTrigger;
1187
+ contexts: [
1188
+ FlowContext,
1189
+ ...FlowContext[]
1190
+ ];
1191
+ /**
1192
+ * An array of purposes to filter workflow phases.
1193
+ */
1194
+ purposes?: string[];
1195
+ }
1196
+ export interface Statement {
1197
+ id: string;
1198
+ source: EvaluationSource;
1199
+ operator: Operator;
1200
+ values: string[];
1201
+ /**
1202
+ * How to interpret values. "static" (default) means literal values. "relative_date" means values[0] is a dynamic date token like "today".
1203
+ */
1204
+ value_type?: "static" | "relative_date";
1205
+ }
1206
+ export interface Step {
1207
+ id: string;
1208
+ definitionId?: string;
1209
+ /**
1210
+ * This field is deprecated. It will be soon removed. Please use only id.
1211
+ */
1212
+ entityRefId?: string;
1213
+ name: string;
1214
+ description?: /* Longer information regarding Task */ StepDescription;
1215
+ type: ItemType;
1216
+ ecp?: /* Details regarding ECP for the workflow step */ ECPDetails;
1217
+ installer?: /* Details regarding ECP for the workflow step */ ECPDetails;
1218
+ partner?: /* Details regarding partner for the workflow step */ PartnerDetails;
1219
+ /**
1220
+ * enabled flag results from calculating the requirements
1221
+ */
1222
+ enabled?: boolean;
1223
+ requirements?: /* describe the requirement for step enablement */ StepRequirement[];
1224
+ executionType?: StepType;
1225
+ sectionId?: string;
1226
+ executionId?: string;
1227
+ /**
1228
+ * This field is deprecated. Please use assignedTo
1229
+ */
1230
+ userIds?: number[];
1231
+ assignedTo?: string[];
1232
+ /**
1233
+ * The user which moved the step/task to the IN_PROGRESS state. The user should also be present in the assignedTo property of the step/task
1234
+ */
1235
+ assignedToInProgress?: string;
1236
+ /**
1237
+ * The user which moved the step/task to the ON_HOLD state. The user should also be present in the assignedTo property of the step/task
1238
+ */
1239
+ assignedToOnHold?: string;
1240
+ status?: /**
1241
+ * **Note**: "UNASSIGNED" and "ASSIGNED" are deprecated and will be removed in a future version. Please use "PENDING" instead. Status values for workflow execution steps/tasks:
1242
+ * - **UNASSIGNED**: Step has not been assigned to any user (deprecated - use PENDING instead)
1243
+ * - **ASSIGNED**: Step has been assigned to one or more users (deprecated - use PENDING instead)
1244
+ * - **PENDING**: Step/Task is waiting to be started by assigned users or is ready for execution
1245
+ * - **IN_PROGRESS**: Step/Task is currently being worked on by a user
1246
+ * - **COMPLETED**: Step/Task has been finished successfully
1247
+ * - **SKIPPED**: Step/Task was intentionally bypassed and will not be executed
1248
+ * - **SCHEDULED**: Task is scheduled to run at a specific time in the future
1249
+ * - **CONDITION_PENDING**: Task is waiting for certain conditions to be met before it can proceed
1250
+ * - **WAITING_FOR_CONFIRMATION**: Step/Task is paused and waiting for user confirmation via an external input (e.g., link in email) before proceeding.
1251
+ * - **ON_HOLD**: Step/Task is temporarily paused and cannot proceed until manually resumed
1252
+ * - **FAILED**: Task encountered an error and could not be completed. Mainly for automation tasks.
1253
+ *
1254
+ */
1255
+ StepStatus;
1256
+ created?: string;
1257
+ lastUpdated?: string;
1258
+ /**
1259
+ * Last updated timestamp of the status
1260
+ */
1261
+ statusLastUpdated?: string;
1262
+ startedTime?: string;
1263
+ completedTime?: string;
1264
+ dueDate?: string;
1265
+ dynamicDueDate?: /* set a Duedate for a step then a specific */ DynamicDueDate;
1266
+ manuallyCreated?: boolean;
1267
+ automationConfig?: /* Configuration for automation execution to run */ AutomationConfig;
1268
+ journey?: StepJourney;
1269
+ /**
1270
+ * Taxonomy ids (purposes in this case) that are associated with this step/task and used for filtering
1271
+ */
1272
+ taxonomies?: string[];
1273
+ }
1274
+ /**
1275
+ * Longer information regarding Task
1276
+ */
1277
+ export interface StepDescription {
1278
+ enabled?: boolean;
1279
+ value?: string;
1280
+ }
1281
+ export interface StepExtended {
1282
+ id: string;
1283
+ definitionId?: string;
1284
+ /**
1285
+ * This field is deprecated. It will be soon removed. Please use only id.
1286
+ */
1287
+ entityRefId?: string;
1288
+ name: string;
1289
+ description?: /* Longer information regarding Task */ StepDescription;
1290
+ type: ItemType;
1291
+ ecp?: /* Details regarding ECP for the workflow step */ ECPDetails;
1292
+ installer?: /* Details regarding ECP for the workflow step */ ECPDetails;
1293
+ partner?: /* Details regarding partner for the workflow step */ PartnerDetails;
1294
+ /**
1295
+ * enabled flag results from calculating the requirements
1296
+ */
1297
+ enabled?: boolean;
1298
+ requirements?: /* describe the requirement for step enablement */ StepRequirement[];
1299
+ executionType?: StepType;
1300
+ sectionId?: string;
1301
+ executionId: string;
1302
+ /**
1303
+ * This field is deprecated. Please use assignedTo
1304
+ */
1305
+ userIds?: number[];
1306
+ assignedTo?: string[];
1307
+ /**
1308
+ * The user which moved the step/task to the IN_PROGRESS state. The user should also be present in the assignedTo property of the step/task
1309
+ */
1310
+ assignedToInProgress?: string;
1311
+ /**
1312
+ * The user which moved the step/task to the ON_HOLD state. The user should also be present in the assignedTo property of the step/task
1313
+ */
1314
+ assignedToOnHold?: string;
1315
+ status?: /**
1316
+ * **Note**: "UNASSIGNED" and "ASSIGNED" are deprecated and will be removed in a future version. Please use "PENDING" instead. Status values for workflow execution steps/tasks:
1317
+ * - **UNASSIGNED**: Step has not been assigned to any user (deprecated - use PENDING instead)
1318
+ * - **ASSIGNED**: Step has been assigned to one or more users (deprecated - use PENDING instead)
1319
+ * - **PENDING**: Step/Task is waiting to be started by assigned users or is ready for execution
1320
+ * - **IN_PROGRESS**: Step/Task is currently being worked on by a user
1321
+ * - **COMPLETED**: Step/Task has been finished successfully
1322
+ * - **SKIPPED**: Step/Task was intentionally bypassed and will not be executed
1323
+ * - **SCHEDULED**: Task is scheduled to run at a specific time in the future
1324
+ * - **CONDITION_PENDING**: Task is waiting for certain conditions to be met before it can proceed
1325
+ * - **WAITING_FOR_CONFIRMATION**: Step/Task is paused and waiting for user confirmation via an external input (e.g., link in email) before proceeding.
1326
+ * - **ON_HOLD**: Step/Task is temporarily paused and cannot proceed until manually resumed
1327
+ * - **FAILED**: Task encountered an error and could not be completed. Mainly for automation tasks.
1328
+ *
1329
+ */
1330
+ StepStatus;
1331
+ created?: string;
1332
+ lastUpdated?: string;
1333
+ /**
1334
+ * Last updated timestamp of the status
1335
+ */
1336
+ statusLastUpdated?: string;
1337
+ startedTime?: string;
1338
+ completedTime?: string;
1339
+ dueDate?: string;
1340
+ dynamicDueDate?: /* set a Duedate for a step then a specific */ DynamicDueDate;
1341
+ manuallyCreated?: boolean;
1342
+ automationConfig?: /* Configuration for automation execution to run */ AutomationConfig;
1343
+ journey?: StepJourney;
1344
+ /**
1345
+ * Taxonomy ids (purposes in this case) that are associated with this step/task and used for filtering
1346
+ */
1347
+ taxonomies?: string[];
1348
+ executionName: string;
1349
+ executionStatus: WorkflowStatus;
1350
+ contexts?: {
1351
+ id: string;
1352
+ title: string;
1353
+ schema: string;
1354
+ }[];
1355
+ }
1356
+ export interface StepId {
1357
+ id?: string;
1358
+ /**
1359
+ * This field is deprecated. It will be soon removed. Please use only id.
1360
+ */
1361
+ entityRefId?: string;
1362
+ }
1363
+ export interface StepJourney {
1364
+ id?: string;
1365
+ journeyId?: string;
1366
+ name?: string;
1367
+ /**
1368
+ * If true, the task be auto completed when the journey is completed
1369
+ */
1370
+ complete_task_automatically?: boolean;
1371
+ }
1372
+ export interface StepPositionAt {
1373
+ index: number;
1374
+ sectionId?: string;
1375
+ }
1376
+ /**
1377
+ * describe the requirement for step enablement
1378
+ */
1379
+ export interface StepRequirement {
1380
+ definitionId: string;
1381
+ type: ItemType;
1382
+ condition: "CLOSED";
1383
+ }
1384
+ export interface StepSimplified {
1385
+ id: string;
1386
+ definitionId?: string;
1387
+ /**
1388
+ * This field is deprecated. It will be soon removed. Please use only id.
1389
+ */
1390
+ entityRefId?: string;
1391
+ name: string;
1392
+ description?: /* Longer information regarding Task */ StepDescription;
1393
+ type: ItemType;
1394
+ ecp?: /* Details regarding ECP for the workflow step */ ECPDetails;
1395
+ installer?: /* Details regarding ECP for the workflow step */ ECPDetails;
1396
+ /**
1397
+ * Partner-specific task details shown to partner org users viewing shared resources
1398
+ */
1399
+ partner?: /* Details regarding partner for the workflow step */ PartnerDetails;
1400
+ enabled?: boolean;
1401
+ requirements?: /* describe the requirement for step enablement */ StepRequirement[];
1402
+ /**
1403
+ * Manual / Automation step
1404
+ */
1405
+ executionType?: StepType;
1406
+ }
1407
+ /**
1408
+ * **Note**: "UNASSIGNED" and "ASSIGNED" are deprecated and will be removed in a future version. Please use "PENDING" instead. Status values for workflow execution steps/tasks:
1409
+ * - **UNASSIGNED**: Step has not been assigned to any user (deprecated - use PENDING instead)
1410
+ * - **ASSIGNED**: Step has been assigned to one or more users (deprecated - use PENDING instead)
1411
+ * - **PENDING**: Step/Task is waiting to be started by assigned users or is ready for execution
1412
+ * - **IN_PROGRESS**: Step/Task is currently being worked on by a user
1413
+ * - **COMPLETED**: Step/Task has been finished successfully
1414
+ * - **SKIPPED**: Step/Task was intentionally bypassed and will not be executed
1415
+ * - **SCHEDULED**: Task is scheduled to run at a specific time in the future
1416
+ * - **CONDITION_PENDING**: Task is waiting for certain conditions to be met before it can proceed
1417
+ * - **WAITING_FOR_CONFIRMATION**: Step/Task is paused and waiting for user confirmation via an external input (e.g., link in email) before proceeding.
1418
+ * - **ON_HOLD**: Step/Task is temporarily paused and cannot proceed until manually resumed
1419
+ * - **FAILED**: Task encountered an error and could not be completed. Mainly for automation tasks.
1420
+ *
1421
+ */
1422
+ export type StepStatus = "UNASSIGNED" | "ASSIGNED" | "COMPLETED" | "SKIPPED" | "IN_PROGRESS" | "SCHEDULED" | "PENDING" | "CONDITION_PENDING" | "WAITING_FOR_CONFIRMATION" | "ON_HOLD" | "FAILED";
1423
+ export type StepType = "MANUAL" | "AUTOMATION";
1424
+ export type Task = ManualTask | AutomationTask | DecisionTask | AiAgentTask;
1425
+ export interface TaskBase {
1426
+ id: TaskId;
1427
+ template_id: string;
1428
+ name: string;
1429
+ description?: /* Longer information regarding Task */ StepDescription;
1430
+ status: /**
1431
+ * **Note**: "UNASSIGNED" and "ASSIGNED" are deprecated and will be removed in a future version. Please use "PENDING" instead. Status values for workflow execution steps/tasks:
1432
+ * - **UNASSIGNED**: Step has not been assigned to any user (deprecated - use PENDING instead)
1433
+ * - **ASSIGNED**: Step has been assigned to one or more users (deprecated - use PENDING instead)
1434
+ * - **PENDING**: Step/Task is waiting to be started by assigned users or is ready for execution
1435
+ * - **IN_PROGRESS**: Step/Task is currently being worked on by a user
1436
+ * - **COMPLETED**: Step/Task has been finished successfully
1437
+ * - **SKIPPED**: Step/Task was intentionally bypassed and will not be executed
1438
+ * - **SCHEDULED**: Task is scheduled to run at a specific time in the future
1439
+ * - **CONDITION_PENDING**: Task is waiting for certain conditions to be met before it can proceed
1440
+ * - **WAITING_FOR_CONFIRMATION**: Step/Task is paused and waiting for user confirmation via an external input (e.g., link in email) before proceeding.
1441
+ * - **ON_HOLD**: Step/Task is temporarily paused and cannot proceed until manually resumed
1442
+ * - **FAILED**: Task encountered an error and could not be completed. Mainly for automation tasks.
1443
+ *
1444
+ */
1445
+ StepStatus;
1446
+ journey?: StepJourney;
1447
+ /**
1448
+ * example:
1449
+ * 2021-04-27T12:00:00.000Z
1450
+ */
1451
+ due_date?: string;
1452
+ due_date_config?: /* Set due date for the task based on a dynamic condition */ DueDateConfig;
1453
+ /**
1454
+ * requirements that need to be fulfilled in order to enable the task while flow instances are running
1455
+ */
1456
+ requirements?: /* describe the requirement for a task to be enabled */ EnableRequirement[];
1457
+ assigned_to?: /* The user ids or variable assignments */ Assignees;
1458
+ analytics: AnalyticsInfo;
1459
+ /**
1460
+ * Time when the task was created
1461
+ */
1462
+ created_at?: string; // date-time
1463
+ /**
1464
+ * Last Update timestamp
1465
+ */
1466
+ updated_at?: string; // date-time
1467
+ /**
1468
+ * Flag to indicate if the task was created manually
1469
+ */
1470
+ manually_created?: boolean;
1471
+ /**
1472
+ * enabled flag results from calculating the requirements
1473
+ */
1474
+ enabled: boolean;
1475
+ ecp?: /* Details regarding ECP for the workflow step */ ECPDetails;
1476
+ installer?: /* Details regarding ECP for the workflow step */ ECPDetails;
1477
+ /**
1478
+ * Partner-specific task details shown to partner org users viewing shared resources
1479
+ */
1480
+ partner?: /* Details regarding partner for the workflow step */ PartnerDetails;
1481
+ /**
1482
+ * Taxonomy ids that are associated with this workflow and used for filtering
1483
+ */
1484
+ taxonomies?: string[];
1485
+ phase_id?: string;
1486
+ task_type: TaskType;
1487
+ }
1488
+ export type TaskId = string;
1489
+ export type TaskType = "MANUAL" | "AUTOMATION" | "DECISION" | "AI_AGENT";
1490
+ export type TimeUnit = "minutes" | "hours" | "days" | "weeks" | "months";
1491
+ export type TriggerMode = "manual" | "automatic";
1492
+ export type TriggerType = "MANUAL" | "AUTOMATIC";
1493
+ export interface UpdateEntityAttributes {
1494
+ source: "workflow_status" | "current_section" | "current_step";
1495
+ target: {
1496
+ /**
1497
+ * example:
1498
+ * opportunity
1499
+ */
1500
+ entitySchema: string;
1501
+ /**
1502
+ * example:
1503
+ * my_status
1504
+ */
1505
+ entityAttribute: string;
1506
+ };
1507
+ }
1508
+ export interface UpdateStepReq {
1509
+ stepId?: string;
1510
+ /**
1511
+ * This field is deprecated. Please use stepId
1512
+ */
1513
+ entityRefId?: string;
1514
+ /**
1515
+ * This field is deprecated. Please use assignedTo
1516
+ */
1517
+ userIds?: number[];
1518
+ assignedTo?: string[];
1519
+ /**
1520
+ * The user which moved the step/task to the IN_PROGRESS state. The user should also be present in the assignedTo property of the step/task
1521
+ */
1522
+ assignedToInProgress?: string;
1523
+ /**
1524
+ * The user which moved the step/task to the ON_HOLD state. The user should also be present in the assignedTo property of the step/task
1525
+ */
1526
+ assignedToOnHold?: string;
1527
+ status?: /**
1528
+ * **Note**: "UNASSIGNED" and "ASSIGNED" are deprecated and will be removed in a future version. Please use "PENDING" instead. Status values for workflow execution steps/tasks:
1529
+ * - **UNASSIGNED**: Step has not been assigned to any user (deprecated - use PENDING instead)
1530
+ * - **ASSIGNED**: Step has been assigned to one or more users (deprecated - use PENDING instead)
1531
+ * - **PENDING**: Step/Task is waiting to be started by assigned users or is ready for execution
1532
+ * - **IN_PROGRESS**: Step/Task is currently being worked on by a user
1533
+ * - **COMPLETED**: Step/Task has been finished successfully
1534
+ * - **SKIPPED**: Step/Task was intentionally bypassed and will not be executed
1535
+ * - **SCHEDULED**: Task is scheduled to run at a specific time in the future
1536
+ * - **CONDITION_PENDING**: Task is waiting for certain conditions to be met before it can proceed
1537
+ * - **WAITING_FOR_CONFIRMATION**: Step/Task is paused and waiting for user confirmation via an external input (e.g., link in email) before proceeding.
1538
+ * - **ON_HOLD**: Step/Task is temporarily paused and cannot proceed until manually resumed
1539
+ * - **FAILED**: Task encountered an error and could not be completed. Mainly for automation tasks.
1540
+ *
1541
+ */
1542
+ StepStatus;
1543
+ dueDate?: string;
1544
+ dynamicDueDate?: /* set a Duedate for a step then a specific */ DynamicDueDate;
1545
+ name?: string;
1546
+ /**
1547
+ * Longer information regarding Task
1548
+ */
1549
+ description?: {
1550
+ enabled: boolean;
1551
+ value: string;
1552
+ };
1553
+ position?: StepPositionAt;
1554
+ automationConfig?: /* Configuration for automation execution to run */ AutomationConfig;
1555
+ startedTime?: string;
1556
+ completedTime?: string;
1557
+ }
1558
+ export interface UpdateStepResp {
1559
+ id: string;
1560
+ definitionId?: string;
1561
+ /**
1562
+ * This field is deprecated. It will be soon removed. Please use only id.
1563
+ */
1564
+ entityRefId?: string;
1565
+ name: string;
1566
+ description?: /* Longer information regarding Task */ StepDescription;
1567
+ type: ItemType;
1568
+ ecp?: /* Details regarding ECP for the workflow step */ ECPDetails;
1569
+ installer?: /* Details regarding ECP for the workflow step */ ECPDetails;
1570
+ partner?: /* Details regarding partner for the workflow step */ PartnerDetails;
1571
+ /**
1572
+ * enabled flag results from calculating the requirements
1573
+ */
1574
+ enabled?: boolean;
1575
+ requirements?: /* describe the requirement for step enablement */ StepRequirement[];
1576
+ executionType?: StepType;
1577
+ sectionId?: string;
1578
+ executionId?: string;
1579
+ /**
1580
+ * This field is deprecated. Please use assignedTo
1581
+ */
1582
+ userIds?: number[];
1583
+ assignedTo?: string[];
1584
+ /**
1585
+ * The user which moved the step/task to the IN_PROGRESS state. The user should also be present in the assignedTo property of the step/task
1586
+ */
1587
+ assignedToInProgress?: string;
1588
+ /**
1589
+ * The user which moved the step/task to the ON_HOLD state. The user should also be present in the assignedTo property of the step/task
1590
+ */
1591
+ assignedToOnHold?: string;
1592
+ status?: /**
1593
+ * **Note**: "UNASSIGNED" and "ASSIGNED" are deprecated and will be removed in a future version. Please use "PENDING" instead. Status values for workflow execution steps/tasks:
1594
+ * - **UNASSIGNED**: Step has not been assigned to any user (deprecated - use PENDING instead)
1595
+ * - **ASSIGNED**: Step has been assigned to one or more users (deprecated - use PENDING instead)
1596
+ * - **PENDING**: Step/Task is waiting to be started by assigned users or is ready for execution
1597
+ * - **IN_PROGRESS**: Step/Task is currently being worked on by a user
1598
+ * - **COMPLETED**: Step/Task has been finished successfully
1599
+ * - **SKIPPED**: Step/Task was intentionally bypassed and will not be executed
1600
+ * - **SCHEDULED**: Task is scheduled to run at a specific time in the future
1601
+ * - **CONDITION_PENDING**: Task is waiting for certain conditions to be met before it can proceed
1602
+ * - **WAITING_FOR_CONFIRMATION**: Step/Task is paused and waiting for user confirmation via an external input (e.g., link in email) before proceeding.
1603
+ * - **ON_HOLD**: Step/Task is temporarily paused and cannot proceed until manually resumed
1604
+ * - **FAILED**: Task encountered an error and could not be completed. Mainly for automation tasks.
1605
+ *
1606
+ */
1607
+ StepStatus;
1608
+ created?: string;
1609
+ lastUpdated?: string;
1610
+ /**
1611
+ * Last updated timestamp of the status
1612
+ */
1613
+ statusLastUpdated?: string;
1614
+ startedTime?: string;
1615
+ completedTime?: string;
1616
+ dueDate?: string;
1617
+ dynamicDueDate?: /* set a Duedate for a step then a specific */ DynamicDueDate;
1618
+ manuallyCreated?: boolean;
1619
+ automationConfig?: /* Configuration for automation execution to run */ AutomationConfig;
1620
+ journey?: StepJourney;
1621
+ /**
1622
+ * Taxonomy ids (purposes in this case) that are associated with this step/task and used for filtering
1623
+ */
1624
+ taxonomies?: string[];
1625
+ }
1626
+ /**
1627
+ * The user id
1628
+ */
1629
+ export type UserId = string;
1630
+ /**
1631
+ * Represents a variable assignment with its expression and optional resolved value. Used for dynamic user assignments that get resolved during workflow execution.
1632
+ */
1633
+ export interface VariableAssignment {
1634
+ /**
1635
+ * The variable expression, e.g., "{{entity.owner}}"
1636
+ * example:
1637
+ * {{entity.owner}}
1638
+ */
1639
+ variable: string;
1640
+ /**
1641
+ * The resolved values after variable evaluation (populated during execution)
1642
+ * example:
1643
+ * [
1644
+ * "user_12345"
1645
+ * ]
1646
+ */
1647
+ value?: string[];
1648
+ }
1649
+ export interface WorkflowContext {
1650
+ id: string;
1651
+ title: string;
1652
+ schema: string;
1653
+ }
1654
+ /**
1655
+ * example:
1656
+ * {
1657
+ * "id": "8gja72h6kas6h",
1658
+ * "name": "Lead Qualification",
1659
+ * "trigger": "MANUAL",
1660
+ * "status": "STARTED",
1661
+ * "creationTime": "2021-04-27T12:01:13.000Z",
1662
+ * "lastUpdateTime": "2021-04-27T12:01:13.000Z",
1663
+ * "dueDate": "2021-04-27T12:01:13.000Z",
1664
+ * "assignedTo": [
1665
+ * "252",
1666
+ * "29052"
1667
+ * ],
1668
+ * "flow": [
1669
+ * {
1670
+ * "id": "sectionId1",
1671
+ * "name": "Initial Information Gathering",
1672
+ * "steps": [
1673
+ * {
1674
+ * "id": "sada5641f3a21",
1675
+ * "name": "Call client and confirm address and product",
1676
+ * "definitionId": "step_definition_id_1",
1677
+ * "status": "ASSIGNED",
1678
+ * "assignedTo": [
1679
+ * "11"
1680
+ * ]
1681
+ * },
1682
+ * {
1683
+ * "id": "sada5641f3a22",
1684
+ * "name": "Check product availability",
1685
+ * "status": "UNASSIGNED",
1686
+ * "definitionId": "step_definition_id_2"
1687
+ * },
1688
+ * {
1689
+ * "id": "sada5641f3a23",
1690
+ * "name": "Send email confirming contact with the client",
1691
+ * "definitionId": "step_definition_id_3",
1692
+ * "status": "SKIPPED"
1693
+ * }
1694
+ * ]
1695
+ * },
1696
+ * {
1697
+ * "id": "firstLevelStepId1",
1698
+ * "definitionId": "step_definition_id_4",
1699
+ * "name": "Print and send catalog",
1700
+ * "status": "SKIPPED",
1701
+ * "dueDate": "2023-01-15T20:00:00"
1702
+ * }
1703
+ * ]
1704
+ * }
1705
+ */
1706
+ export interface WorkflowExecution {
1707
+ id?: string;
1708
+ definitionId?: string;
1709
+ orgId?: string;
1710
+ name?: string;
1711
+ /**
1712
+ * Creation timestamp which will double as started time as well
1713
+ */
1714
+ creationTime?: string;
1715
+ /**
1716
+ * Last Update timestamp
1717
+ */
1718
+ lastUpdateTime?: string;
1719
+ /**
1720
+ * Due date for finishing the workflow
1721
+ */
1722
+ dueDate?: string;
1723
+ /**
1724
+ * Completed time of the workflow execution
1725
+ */
1726
+ completedTime?: string;
1727
+ dynamicDueDate?: /* set a Duedate for a step then a specific */ DynamicDueDate;
1728
+ status?: WorkflowStatus;
1729
+ trigger?: TriggerType;
1730
+ assignedTo?: string[];
1731
+ /**
1732
+ * Id of the user who closed workflow
1733
+ */
1734
+ lastModifiedBy?: string;
1735
+ contexts?: WorkflowContext[];
1736
+ nextOpenStep?: StepId;
1737
+ configuredClosingReasonSnapshot?: ClosingReason[];
1738
+ selectedClosingReasons?: ClosingReason[];
1739
+ closingReasonDescription?: string;
1740
+ /**
1741
+ * Indicates whether this workflow is available for End Customer Portal or not. By default it's not.
1742
+ */
1743
+ enableECPWorkflow?: boolean;
1744
+ updateEntityAttributes?: UpdateEntityAttributes[];
1745
+ /**
1746
+ * Version of the workflow execution.
1747
+ */
1748
+ version?: number;
1749
+ /**
1750
+ * Taxonomy ids (both Labels and Purposes) that are associated with this workflow and used for filtering
1751
+ */
1752
+ taxonomies?: string[];
1753
+ /**
1754
+ * Indicates whether only a single closing reason can be selected when closing the workflow execution
1755
+ */
1756
+ singleClosingReasonSelection?: boolean;
1757
+ flow: (/* A group of Steps that define the progress of the Workflow */ Section | Step)[];
1758
+ }
1759
+ export interface WorkflowExecutionBase {
1760
+ id?: string;
1761
+ definitionId?: string;
1762
+ orgId?: string;
1763
+ name?: string;
1764
+ /**
1765
+ * Creation timestamp which will double as started time as well
1766
+ */
1767
+ creationTime?: string;
1768
+ /**
1769
+ * Last Update timestamp
1770
+ */
1771
+ lastUpdateTime?: string;
1772
+ /**
1773
+ * Due date for finishing the workflow
1774
+ */
1775
+ dueDate?: string;
1776
+ /**
1777
+ * Completed time of the workflow execution
1778
+ */
1779
+ completedTime?: string;
1780
+ dynamicDueDate?: /* set a Duedate for a step then a specific */ DynamicDueDate;
1781
+ status?: WorkflowStatus;
1782
+ trigger?: TriggerType;
1783
+ assignedTo?: string[];
1784
+ /**
1785
+ * Id of the user who closed workflow
1786
+ */
1787
+ lastModifiedBy?: string;
1788
+ contexts?: WorkflowContext[];
1789
+ nextOpenStep?: StepId;
1790
+ configuredClosingReasonSnapshot?: ClosingReason[];
1791
+ selectedClosingReasons?: ClosingReason[];
1792
+ closingReasonDescription?: string;
1793
+ /**
1794
+ * Indicates whether this workflow is available for End Customer Portal or not. By default it's not.
1795
+ */
1796
+ enableECPWorkflow?: boolean;
1797
+ updateEntityAttributes?: UpdateEntityAttributes[];
1798
+ /**
1799
+ * Version of the workflow execution.
1800
+ */
1801
+ version?: number;
1802
+ /**
1803
+ * Taxonomy ids (both Labels and Purposes) that are associated with this workflow and used for filtering
1804
+ */
1805
+ taxonomies?: string[];
1806
+ /**
1807
+ * Indicates whether only a single closing reason can be selected when closing the workflow execution
1808
+ */
1809
+ singleClosingReasonSelection?: boolean;
1810
+ }
1811
+ /**
1812
+ * example:
1813
+ * {
1814
+ * "workflowId": "j3f23fh23uif98",
1815
+ * "trigger": "AUTOMATIC",
1816
+ * "contexts": [
1817
+ * {
1818
+ * "id": "3fa3fa86-0907-4642-a57e-0fe30a19874d",
1819
+ * "schema": "contact"
1820
+ * },
1821
+ * {
1822
+ * "id": "3a6d42fa-5070-4723-b90f-41ead4303e33",
1823
+ * "schema": "opportunity"
1824
+ * }
1825
+ * ]
1826
+ * }
1827
+ */
1828
+ export interface WorkflowExecutionCreateReq {
1829
+ workflowId: string;
1830
+ trigger?: TriggerType;
1831
+ assignedTo?: string[];
1832
+ contexts?: WorkflowContext[];
1833
+ /**
1834
+ * An array of purposes to filter workflow phases.
1835
+ */
1836
+ purposes?: string[];
1837
+ }
1838
+ /**
1839
+ * example:
1840
+ * {
1841
+ * "id": "8gja72h6kas6h",
1842
+ * "name": "Lead Qualification",
1843
+ * "trigger": "MANUAL",
1844
+ * "status": "STARTED",
1845
+ * "creationTime": "2021-04-27T12:01:13.000Z",
1846
+ * "lastUpdateTime": "2021-04-27T12:01:13.000Z",
1847
+ * "dueDate": "2021-04-27T12:01:13.000Z",
1848
+ * "flow": [
1849
+ * {
1850
+ * "id": "sectionId1",
1851
+ * "definitionId": "section_definition_id_1",
1852
+ * "name": "Initial Information Gathering",
1853
+ * "type": "SECTION",
1854
+ * "steps": [
1855
+ * {
1856
+ * "id": "sada5641f3a21",
1857
+ * "definitionId": "step_definition_id_1",
1858
+ * "name": "Call client"
1859
+ * },
1860
+ * {
1861
+ * "id": "sada5641f3a22",
1862
+ * "definitionId": "step_definition_id_2",
1863
+ * "name": "Check product availability"
1864
+ * },
1865
+ * {
1866
+ * "id": "sada5641f3a23",
1867
+ * "definitionId": "step_definition_id_3",
1868
+ * "name": "Send email confirming contact with the client"
1869
+ * }
1870
+ * ]
1871
+ * },
1872
+ * {
1873
+ * "id": "firstLevelStepId1",
1874
+ * "definitionId": "step_definition_id_4",
1875
+ * "name": "Print and send catalog",
1876
+ * "type": "STEP"
1877
+ * }
1878
+ * ]
1879
+ * }
1880
+ */
1881
+ export interface WorkflowExecutionSlim {
1882
+ id?: string;
1883
+ definitionId?: string;
1884
+ orgId?: string;
1885
+ name?: string;
1886
+ /**
1887
+ * Creation timestamp which will double as started time as well
1888
+ */
1889
+ creationTime?: string;
1890
+ /**
1891
+ * Last Update timestamp
1892
+ */
1893
+ lastUpdateTime?: string;
1894
+ /**
1895
+ * Due date for finishing the workflow
1896
+ */
1897
+ dueDate?: string;
1898
+ /**
1899
+ * Completed time of the workflow execution
1900
+ */
1901
+ completedTime?: string;
1902
+ dynamicDueDate?: /* set a Duedate for a step then a specific */ DynamicDueDate;
1903
+ status?: WorkflowStatus;
1904
+ trigger?: TriggerType;
1905
+ assignedTo?: string[];
1906
+ /**
1907
+ * Id of the user who closed workflow
1908
+ */
1909
+ lastModifiedBy?: string;
1910
+ contexts?: WorkflowContext[];
1911
+ nextOpenStep?: StepId;
1912
+ configuredClosingReasonSnapshot?: ClosingReason[];
1913
+ selectedClosingReasons?: ClosingReason[];
1914
+ closingReasonDescription?: string;
1915
+ /**
1916
+ * Indicates whether this workflow is available for End Customer Portal or not. By default it's not.
1917
+ */
1918
+ enableECPWorkflow?: boolean;
1919
+ updateEntityAttributes?: UpdateEntityAttributes[];
1920
+ /**
1921
+ * Version of the workflow execution.
1922
+ */
1923
+ version?: number;
1924
+ /**
1925
+ * Taxonomy ids (both Labels and Purposes) that are associated with this workflow and used for filtering
1926
+ */
1927
+ taxonomies?: string[];
1928
+ /**
1929
+ * Indicates whether only a single closing reason can be selected when closing the workflow execution
1930
+ */
1931
+ singleClosingReasonSelection?: boolean;
1932
+ flow: (/* A group of Steps that define the progress of the Workflow */ Section | Step)[];
1933
+ }
1934
+ export interface WorkflowExecutionUpdateReq {
1935
+ status?: WorkflowStatus;
1936
+ assignedTo?: string[];
1937
+ selectedClosingReasons?: ClosingReason[];
1938
+ closingReasonDescription?: string;
1939
+ dueDate?: string;
1940
+ dynamicDueDate?: /* set a Duedate for a step then a specific */ DynamicDueDate;
1941
+ /**
1942
+ * id of the user / partner user who is closing the workflow. For partner pass orgId_userId.
1943
+ */
1944
+ closedBy?: string;
1945
+ contexts?: WorkflowContext[];
1946
+ /**
1947
+ * Completed time of the workflow execution
1948
+ */
1949
+ completedTime?: string;
1950
+ }
1951
+ export interface WorkflowInEntity {
1952
+ id?: string;
1953
+ definition_id?: string;
1954
+ name?: string;
1955
+ status?: WorkflowStatus;
1956
+ assignees?: string[];
1957
+ duedate?: string; // date-time
1958
+ last_update_time?: string; // date-time
1959
+ progress?: number;
1960
+ upcoming_tasks_assignees?: string[];
1961
+ task_id?: string;
1962
+ task_name?: string;
1963
+ task_assignees?: string[];
1964
+ task_duedate?: string; // date-time
1965
+ task_execution_type?: StepType;
1966
+ task_status?: /**
1967
+ * **Note**: "UNASSIGNED" and "ASSIGNED" are deprecated and will be removed in a future version. Please use "PENDING" instead. Status values for workflow execution steps/tasks:
1968
+ * - **UNASSIGNED**: Step has not been assigned to any user (deprecated - use PENDING instead)
1969
+ * - **ASSIGNED**: Step has been assigned to one or more users (deprecated - use PENDING instead)
1970
+ * - **PENDING**: Step/Task is waiting to be started by assigned users or is ready for execution
1971
+ * - **IN_PROGRESS**: Step/Task is currently being worked on by a user
1972
+ * - **COMPLETED**: Step/Task has been finished successfully
1973
+ * - **SKIPPED**: Step/Task was intentionally bypassed and will not be executed
1974
+ * - **SCHEDULED**: Task is scheduled to run at a specific time in the future
1975
+ * - **CONDITION_PENDING**: Task is waiting for certain conditions to be met before it can proceed
1976
+ * - **WAITING_FOR_CONFIRMATION**: Step/Task is paused and waiting for user confirmation via an external input (e.g., link in email) before proceeding.
1977
+ * - **ON_HOLD**: Step/Task is temporarily paused and cannot proceed until manually resumed
1978
+ * - **FAILED**: Task encountered an error and could not be completed. Mainly for automation tasks.
1979
+ *
1980
+ */
1981
+ StepStatus;
1982
+ phase_id?: string;
1983
+ phase_name?: string;
1984
+ phase_assignees?: string[];
1985
+ phase_progress?: number;
1986
+ phases_in_progress?: PhaseInEntity[];
1987
+ selected_closing_reasons?: ClosingReason[];
1988
+ closing_reason_description?: string;
1989
+ }
1990
+ export type WorkflowStatus = "STARTED" | "DONE" | "CLOSED";
1991
+ }
1992
+ }
1993
+ declare namespace Paths {
1994
+ namespace AddTask {
1995
+ namespace Parameters {
1996
+ export type ExecutionId = string;
1997
+ }
1998
+ export interface PathParameters {
1999
+ execution_id: Parameters.ExecutionId;
2000
+ }
2001
+ export type RequestBody = Components.Schemas.AddTaskReq;
2002
+ namespace Responses {
2003
+ export type $201 = Components.Schemas.Task;
2004
+ export type $400 = Components.Schemas.ErrorResp;
2005
+ export type $401 = Components.Schemas.ErrorResp;
2006
+ export type $500 = Components.Schemas.ErrorResp;
2007
+ }
2008
+ }
2009
+ namespace CancelSchedule {
2010
+ namespace Parameters {
2011
+ export type ExecutionId = string;
2012
+ export type ScheduleId = string;
2013
+ }
2014
+ export interface PathParameters {
2015
+ execution_id: Parameters.ExecutionId;
2016
+ schedule_id: Parameters.ScheduleId;
2017
+ }
2018
+ namespace Responses {
2019
+ export interface $204 {
2020
+ }
2021
+ export type $400 = Components.Schemas.ErrorResp;
2022
+ export type $401 = Components.Schemas.ErrorResp;
2023
+ export type $404 = Components.Schemas.ErrorResp;
2024
+ export type $500 = Components.Schemas.ErrorResp;
2025
+ }
2026
+ }
2027
+ namespace CancelTaskSchedule {
2028
+ namespace Parameters {
2029
+ export type ExecutionId = string;
2030
+ export type TaskId = string;
2031
+ }
2032
+ export interface PathParameters {
2033
+ execution_id: Parameters.ExecutionId;
2034
+ task_id: Parameters.TaskId;
2035
+ }
2036
+ namespace Responses {
2037
+ export interface $204 {
2038
+ }
2039
+ export type $400 = Components.Schemas.ErrorResp;
2040
+ export type $401 = Components.Schemas.ErrorResp;
2041
+ export type $404 = Components.Schemas.ErrorResp;
2042
+ export type $500 = Components.Schemas.ErrorResp;
2043
+ }
2044
+ }
2045
+ namespace CreateExecution {
2046
+ export type RequestBody = /**
2047
+ * example:
2048
+ * {
2049
+ * "workflowId": "j3f23fh23uif98",
2050
+ * "trigger": "AUTOMATIC",
2051
+ * "contexts": [
2052
+ * {
2053
+ * "id": "3fa3fa86-0907-4642-a57e-0fe30a19874d",
2054
+ * "schema": "contact"
2055
+ * },
2056
+ * {
2057
+ * "id": "3a6d42fa-5070-4723-b90f-41ead4303e33",
2058
+ * "schema": "opportunity"
2059
+ * }
2060
+ * ]
2061
+ * }
2062
+ */
2063
+ Components.Schemas.WorkflowExecutionCreateReq;
2064
+ namespace Responses {
2065
+ export type $201 = /**
2066
+ * example:
2067
+ * {
2068
+ * "id": "8gja72h6kas6h",
2069
+ * "name": "Lead Qualification",
2070
+ * "trigger": "MANUAL",
2071
+ * "status": "STARTED",
2072
+ * "creationTime": "2021-04-27T12:01:13.000Z",
2073
+ * "lastUpdateTime": "2021-04-27T12:01:13.000Z",
2074
+ * "dueDate": "2021-04-27T12:01:13.000Z",
2075
+ * "assignedTo": [
2076
+ * "252",
2077
+ * "29052"
2078
+ * ],
2079
+ * "flow": [
2080
+ * {
2081
+ * "id": "sectionId1",
2082
+ * "name": "Initial Information Gathering",
2083
+ * "steps": [
2084
+ * {
2085
+ * "id": "sada5641f3a21",
2086
+ * "name": "Call client and confirm address and product",
2087
+ * "definitionId": "step_definition_id_1",
2088
+ * "status": "ASSIGNED",
2089
+ * "assignedTo": [
2090
+ * "11"
2091
+ * ]
2092
+ * },
2093
+ * {
2094
+ * "id": "sada5641f3a22",
2095
+ * "name": "Check product availability",
2096
+ * "status": "UNASSIGNED",
2097
+ * "definitionId": "step_definition_id_2"
2098
+ * },
2099
+ * {
2100
+ * "id": "sada5641f3a23",
2101
+ * "name": "Send email confirming contact with the client",
2102
+ * "definitionId": "step_definition_id_3",
2103
+ * "status": "SKIPPED"
2104
+ * }
2105
+ * ]
2106
+ * },
2107
+ * {
2108
+ * "id": "firstLevelStepId1",
2109
+ * "definitionId": "step_definition_id_4",
2110
+ * "name": "Print and send catalog",
2111
+ * "status": "SKIPPED",
2112
+ * "dueDate": "2023-01-15T20:00:00"
2113
+ * }
2114
+ * ]
2115
+ * }
2116
+ */
2117
+ Components.Schemas.WorkflowExecution;
2118
+ export type $400 = Components.Schemas.ErrorResp;
2119
+ export type $401 = Components.Schemas.ErrorResp;
2120
+ export type $500 = Components.Schemas.ErrorResp;
2121
+ }
2122
+ }
2123
+ namespace CreateStep {
2124
+ namespace Parameters {
2125
+ export type ExecutionId = string;
2126
+ }
2127
+ export interface PathParameters {
2128
+ executionId: Parameters.ExecutionId;
2129
+ }
2130
+ export type RequestBody = Components.Schemas.CreateStepReq;
2131
+ namespace Responses {
2132
+ export type $201 = Components.Schemas.Step;
2133
+ export type $400 = Components.Schemas.ErrorResp;
2134
+ export type $401 = Components.Schemas.ErrorResp;
2135
+ export type $500 = Components.Schemas.ErrorResp;
2136
+ }
2137
+ }
2138
+ namespace DeleteExecution {
2139
+ namespace Parameters {
2140
+ export type ExecutionId = string;
2141
+ }
2142
+ export interface PathParameters {
2143
+ executionId: Parameters.ExecutionId;
2144
+ }
2145
+ namespace Responses {
2146
+ export interface $204 {
2147
+ }
2148
+ export type $401 = Components.Schemas.ErrorResp;
2149
+ export interface $404 {
2150
+ }
2151
+ }
2152
+ }
2153
+ namespace DeleteFlowExecution {
2154
+ namespace Parameters {
2155
+ export type ExecutionId = string;
2156
+ export type Soft = boolean;
2157
+ }
2158
+ export interface PathParameters {
2159
+ execution_id: Parameters.ExecutionId;
2160
+ }
2161
+ export interface QueryParameters {
2162
+ soft?: Parameters.Soft;
2163
+ }
2164
+ namespace Responses {
2165
+ export interface $204 {
2166
+ }
2167
+ export interface $401 {
2168
+ }
2169
+ export interface $403 {
2170
+ }
2171
+ export interface $404 {
2172
+ }
2173
+ }
2174
+ }
2175
+ namespace DeleteStep {
2176
+ namespace Parameters {
2177
+ export type ExecutionId = string;
2178
+ export type StepId = string;
2179
+ }
2180
+ export interface PathParameters {
2181
+ executionId: Parameters.ExecutionId;
2182
+ stepId: Parameters.StepId;
2183
+ }
2184
+ namespace Responses {
2185
+ export interface $204 {
2186
+ }
2187
+ export type $500 = Components.Schemas.ErrorResp;
2188
+ }
2189
+ }
2190
+ namespace ExecuteTask {
2191
+ namespace Parameters {
2192
+ export type ExecutionId = string;
2193
+ export type TaskId = string;
2194
+ }
2195
+ export interface PathParameters {
2196
+ execution_id: Parameters.ExecutionId;
2197
+ task_id: Parameters.TaskId;
2198
+ }
2199
+ namespace Responses {
2200
+ export type $200 = Components.Schemas.Task;
2201
+ export type $400 = Components.Schemas.ErrorResp;
2202
+ export type $401 = Components.Schemas.ErrorResp;
2203
+ export type $500 = Components.Schemas.ErrorResp;
2204
+ }
2205
+ }
2206
+ namespace GetClosingReasonExecution {
2207
+ namespace Parameters {
2208
+ export type ExecutionId = string;
2209
+ }
2210
+ export interface PathParameters {
2211
+ executionId: Parameters.ExecutionId;
2212
+ }
2213
+ namespace Responses {
2214
+ export type $200 = Components.Schemas.ClosingReasonResp;
2215
+ export type $500 = Components.Schemas.ErrorResp;
2216
+ }
2217
+ }
2218
+ namespace GetExecution {
2219
+ namespace Parameters {
2220
+ export type ExecutionId = string;
2221
+ }
2222
+ export interface PathParameters {
2223
+ executionId: Parameters.ExecutionId;
2224
+ }
2225
+ namespace Responses {
2226
+ export type $200 = /**
2227
+ * example:
2228
+ * {
2229
+ * "id": "8gja72h6kas6h",
2230
+ * "name": "Lead Qualification",
2231
+ * "trigger": "MANUAL",
2232
+ * "status": "STARTED",
2233
+ * "creationTime": "2021-04-27T12:01:13.000Z",
2234
+ * "lastUpdateTime": "2021-04-27T12:01:13.000Z",
2235
+ * "dueDate": "2021-04-27T12:01:13.000Z",
2236
+ * "assignedTo": [
2237
+ * "252",
2238
+ * "29052"
2239
+ * ],
2240
+ * "flow": [
2241
+ * {
2242
+ * "id": "sectionId1",
2243
+ * "name": "Initial Information Gathering",
2244
+ * "steps": [
2245
+ * {
2246
+ * "id": "sada5641f3a21",
2247
+ * "name": "Call client and confirm address and product",
2248
+ * "definitionId": "step_definition_id_1",
2249
+ * "status": "ASSIGNED",
2250
+ * "assignedTo": [
2251
+ * "11"
2252
+ * ]
2253
+ * },
2254
+ * {
2255
+ * "id": "sada5641f3a22",
2256
+ * "name": "Check product availability",
2257
+ * "status": "UNASSIGNED",
2258
+ * "definitionId": "step_definition_id_2"
2259
+ * },
2260
+ * {
2261
+ * "id": "sada5641f3a23",
2262
+ * "name": "Send email confirming contact with the client",
2263
+ * "definitionId": "step_definition_id_3",
2264
+ * "status": "SKIPPED"
2265
+ * }
2266
+ * ]
2267
+ * },
2268
+ * {
2269
+ * "id": "firstLevelStepId1",
2270
+ * "definitionId": "step_definition_id_4",
2271
+ * "name": "Print and send catalog",
2272
+ * "status": "SKIPPED",
2273
+ * "dueDate": "2023-01-15T20:00:00"
2274
+ * }
2275
+ * ]
2276
+ * }
2277
+ */
2278
+ Components.Schemas.WorkflowExecution;
2279
+ export type $500 = Components.Schemas.ErrorResp;
2280
+ }
2281
+ }
2282
+ namespace GetExecutions {
2283
+ namespace Parameters {
2284
+ export type Context = string;
2285
+ export type Schema = string;
2286
+ }
2287
+ export interface QueryParameters {
2288
+ context?: Parameters.Context;
2289
+ schema?: Parameters.Schema;
2290
+ }
2291
+ namespace Responses {
2292
+ export type $200 = /**
2293
+ * example:
2294
+ * {
2295
+ * "id": "8gja72h6kas6h",
2296
+ * "name": "Lead Qualification",
2297
+ * "trigger": "MANUAL",
2298
+ * "status": "STARTED",
2299
+ * "creationTime": "2021-04-27T12:01:13.000Z",
2300
+ * "lastUpdateTime": "2021-04-27T12:01:13.000Z",
2301
+ * "dueDate": "2021-04-27T12:01:13.000Z",
2302
+ * "flow": [
2303
+ * {
2304
+ * "id": "sectionId1",
2305
+ * "definitionId": "section_definition_id_1",
2306
+ * "name": "Initial Information Gathering",
2307
+ * "type": "SECTION",
2308
+ * "steps": [
2309
+ * {
2310
+ * "id": "sada5641f3a21",
2311
+ * "definitionId": "step_definition_id_1",
2312
+ * "name": "Call client"
2313
+ * },
2314
+ * {
2315
+ * "id": "sada5641f3a22",
2316
+ * "definitionId": "step_definition_id_2",
2317
+ * "name": "Check product availability"
2318
+ * },
2319
+ * {
2320
+ * "id": "sada5641f3a23",
2321
+ * "definitionId": "step_definition_id_3",
2322
+ * "name": "Send email confirming contact with the client"
2323
+ * }
2324
+ * ]
2325
+ * },
2326
+ * {
2327
+ * "id": "firstLevelStepId1",
2328
+ * "definitionId": "step_definition_id_4",
2329
+ * "name": "Print and send catalog",
2330
+ * "type": "STEP"
2331
+ * }
2332
+ * ]
2333
+ * }
2334
+ */
2335
+ Components.Schemas.WorkflowExecutionSlim[];
2336
+ export type $500 = Components.Schemas.ErrorResp;
2337
+ }
2338
+ }
2339
+ namespace GetFlowExecution {
2340
+ namespace Parameters {
2341
+ export type ExecutionId = string;
2342
+ }
2343
+ export interface PathParameters {
2344
+ execution_id: Parameters.ExecutionId;
2345
+ }
2346
+ namespace Responses {
2347
+ export type $200 = Components.Schemas.FlowExecution;
2348
+ export interface $401 {
2349
+ }
2350
+ export interface $403 {
2351
+ }
2352
+ export interface $404 {
2353
+ }
2354
+ }
2355
+ }
2356
+ namespace PatchFlowExecution {
2357
+ namespace Parameters {
2358
+ export type ExecutionId = string;
2359
+ }
2360
+ export interface PathParameters {
2361
+ execution_id: Parameters.ExecutionId;
2362
+ }
2363
+ export type RequestBody = Components.Schemas.PatchFlowReq;
2364
+ namespace Responses {
2365
+ export type $200 = Components.Schemas.FlowExecution;
2366
+ export interface $401 {
2367
+ }
2368
+ export interface $403 {
2369
+ }
2370
+ export interface $404 {
2371
+ }
2372
+ export type $500 = Components.Schemas.ErrorResp;
2373
+ }
2374
+ }
2375
+ namespace PatchPhase {
2376
+ namespace Parameters {
2377
+ export type ExecutionId = string;
2378
+ export type PhaseId = string;
2379
+ }
2380
+ export interface PathParameters {
2381
+ execution_id: Parameters.ExecutionId;
2382
+ phase_id: Parameters.PhaseId;
2383
+ }
2384
+ export type RequestBody = Components.Schemas.PatchPhaseReq;
2385
+ namespace Responses {
2386
+ export type $200 = Components.Schemas.Phase;
2387
+ export type $400 = Components.Schemas.ErrorResp;
2388
+ export type $401 = Components.Schemas.ErrorResp;
2389
+ export type $500 = Components.Schemas.ErrorResp;
2390
+ }
2391
+ }
2392
+ namespace PatchTask {
2393
+ namespace Parameters {
2394
+ export type ExecutionId = string;
2395
+ export type TaskId = string;
2396
+ }
2397
+ export interface PathParameters {
2398
+ execution_id: Parameters.ExecutionId;
2399
+ task_id: Parameters.TaskId;
2400
+ }
2401
+ export type RequestBody = Components.Schemas.PatchTaskReq;
2402
+ namespace Responses {
2403
+ export type $200 = Components.Schemas.Task;
2404
+ export type $400 = Components.Schemas.ErrorResp;
2405
+ export type $401 = Components.Schemas.ErrorResp;
2406
+ export type $500 = Components.Schemas.ErrorResp;
2407
+ }
2408
+ }
2409
+ namespace RunTaskAutomation {
2410
+ namespace Parameters {
2411
+ export type ExecutionId = string;
2412
+ export type TaskId = string;
2413
+ }
2414
+ export interface PathParameters {
2415
+ execution_id: Parameters.ExecutionId;
2416
+ task_id: Parameters.TaskId;
2417
+ }
2418
+ namespace Responses {
2419
+ export type $200 = Components.Schemas.AutomationTask;
2420
+ export type $400 = Components.Schemas.ErrorResp;
2421
+ export type $401 = Components.Schemas.ErrorResp;
2422
+ export type $500 = Components.Schemas.ErrorResp;
2423
+ }
2424
+ }
2425
+ namespace RunTaskScheduleNow {
2426
+ namespace Parameters {
2427
+ export type ExecutionId = string;
2428
+ export type TaskId = string;
2429
+ }
2430
+ export interface PathParameters {
2431
+ execution_id: Parameters.ExecutionId;
2432
+ task_id: Parameters.TaskId;
2433
+ }
2434
+ namespace Responses {
2435
+ export type $200 = Components.Schemas.Task;
2436
+ export type $400 = Components.Schemas.ErrorResp;
2437
+ export type $401 = Components.Schemas.ErrorResp;
2438
+ export type $404 = Components.Schemas.ErrorResp;
2439
+ export type $500 = Components.Schemas.ErrorResp;
2440
+ }
2441
+ }
2442
+ namespace SearchExecutions {
2443
+ export type RequestBody = Components.Schemas.SearchExecutionsReq;
2444
+ namespace Responses {
2445
+ export type $200 = Components.Schemas.SearchExecutionsResp;
2446
+ export type $400 = Components.Schemas.ErrorResp;
2447
+ export type $401 = Components.Schemas.ErrorResp;
2448
+ export type $500 = Components.Schemas.ErrorResp;
2449
+ }
2450
+ }
2451
+ namespace SearchFlowExecutions {
2452
+ export type RequestBody = Components.Schemas.SearchFlowsReq;
2453
+ namespace Responses {
2454
+ export interface $200 {
2455
+ results?: Components.Schemas.FlowExecution[];
2456
+ }
2457
+ export type $400 = Components.Schemas.ErrorResp;
2458
+ export interface $401 {
2459
+ }
2460
+ export interface $403 {
2461
+ }
2462
+ export type $500 = Components.Schemas.ErrorResp;
2463
+ }
2464
+ }
2465
+ namespace SearchSteps {
2466
+ export type RequestBody = Components.Schemas.SearchStepsReq;
2467
+ namespace Responses {
2468
+ export type $200 = Components.Schemas.SearchStepsResp;
2469
+ export type $400 = Components.Schemas.ErrorResp;
2470
+ export type $401 = Components.Schemas.ErrorResp;
2471
+ export type $500 = Components.Schemas.ErrorResp;
2472
+ }
2473
+ }
2474
+ namespace StartFlowExecution {
2475
+ export type RequestBody = Components.Schemas.StartFlowReq;
2476
+ namespace Responses {
2477
+ export type $201 = Components.Schemas.FlowExecution;
2478
+ export type $400 = Components.Schemas.ErrorResp;
2479
+ export interface $401 {
2480
+ }
2481
+ export interface $403 {
2482
+ }
2483
+ export type $500 = Components.Schemas.ErrorResp;
2484
+ }
2485
+ }
2486
+ namespace UpdateExecution {
2487
+ namespace Parameters {
2488
+ export type ExecutionId = string;
2489
+ }
2490
+ export interface PathParameters {
2491
+ executionId: Parameters.ExecutionId;
2492
+ }
2493
+ export type RequestBody = Components.Schemas.WorkflowExecutionUpdateReq;
2494
+ namespace Responses {
2495
+ export interface $204 {
2496
+ }
2497
+ export type $500 = Components.Schemas.ErrorResp;
2498
+ }
2499
+ }
2500
+ namespace UpdateStep {
2501
+ namespace Parameters {
2502
+ export type ExecutionId = string;
2503
+ export type StepId = string;
2504
+ }
2505
+ export interface PathParameters {
2506
+ executionId: Parameters.ExecutionId;
2507
+ stepId: Parameters.StepId;
2508
+ }
2509
+ export type RequestBody = Components.Schemas.UpdateStepReq;
2510
+ namespace Responses {
2511
+ export type $200 = Components.Schemas.Step;
2512
+ export type $400 = Components.Schemas.ErrorResp;
2513
+ export type $401 = Components.Schemas.ErrorResp;
2514
+ export type $500 = Components.Schemas.ErrorResp;
2515
+ }
2516
+ }
2517
+ }
2518
+
2519
+
2520
+ interface OperationMethods {
2521
+ /**
2522
+ * getExecutions - getExecutions
2523
+ *
2524
+ * Retrieve Workflow Executions. Optionally, you can filter them by context & schema. Please be aware, these executions are more light weight - steps are not loaded with all information.
2525
+ */
2526
+ 'getExecutions'(
2527
+ parameters?: Parameters<Paths.GetExecutions.QueryParameters> | null,
2528
+ data?: any,
2529
+ config?: AxiosRequestConfig
2530
+ ): OperationResponse<Paths.GetExecutions.Responses.$200>
2531
+ /**
2532
+ * createExecution - createExecution
2533
+ *
2534
+ * Create a Workflow Execution. Start a new workflow execution, based on a workflow definition (template).
2535
+ */
2536
+ 'createExecution'(
2537
+ parameters?: Parameters<UnknownParamsObject> | null,
2538
+ data?: Paths.CreateExecution.RequestBody,
2539
+ config?: AxiosRequestConfig
2540
+ ): OperationResponse<Paths.CreateExecution.Responses.$201>
2541
+ /**
2542
+ * getExecution - getExecution
2543
+ *
2544
+ * Get a full workflow execution, included steps information, by execution id.
2545
+ */
2546
+ 'getExecution'(
2547
+ parameters?: Parameters<Paths.GetExecution.PathParameters> | null,
2548
+ data?: any,
2549
+ config?: AxiosRequestConfig
2550
+ ): OperationResponse<Paths.GetExecution.Responses.$200>
2551
+ /**
2552
+ * updateExecution - updateExecution
2553
+ *
2554
+ * Patches updates like assignees, status, closingReason for a single Workflow Execution.
2555
+ */
2556
+ 'updateExecution'(
2557
+ parameters?: Parameters<Paths.UpdateExecution.PathParameters> | null,
2558
+ data?: Paths.UpdateExecution.RequestBody,
2559
+ config?: AxiosRequestConfig
2560
+ ): OperationResponse<Paths.UpdateExecution.Responses.$204>
2561
+ /**
2562
+ * deleteExecution - deleteExecution
2563
+ *
2564
+ * Delete workflow execution by id. Workflow contexts will NOT be deleted.
2565
+ */
2566
+ 'deleteExecution'(
2567
+ parameters?: Parameters<Paths.DeleteExecution.PathParameters> | null,
2568
+ data?: any,
2569
+ config?: AxiosRequestConfig
2570
+ ): OperationResponse<Paths.DeleteExecution.Responses.$204>
2571
+ /**
2572
+ * createStep - createStep
2573
+ *
2574
+ * Create a new step in current workflow execution.
2575
+ */
2576
+ 'createStep'(
2577
+ parameters?: Parameters<Paths.CreateStep.PathParameters> | null,
2578
+ data?: Paths.CreateStep.RequestBody,
2579
+ config?: AxiosRequestConfig
2580
+ ): OperationResponse<Paths.CreateStep.Responses.$201>
2581
+ /**
2582
+ * updateStep - updateStep
2583
+ *
2584
+ * Patches various changes to a workflow execution step.
2585
+ */
2586
+ 'updateStep'(
2587
+ parameters?: Parameters<Paths.UpdateStep.PathParameters> | null,
2588
+ data?: Paths.UpdateStep.RequestBody,
2589
+ config?: AxiosRequestConfig
2590
+ ): OperationResponse<Paths.UpdateStep.Responses.$200>
2591
+ /**
2592
+ * deleteStep - deleteStep
2593
+ *
2594
+ * Deletes a step from a workflow execution.
2595
+ */
2596
+ 'deleteStep'(
2597
+ parameters?: Parameters<Paths.DeleteStep.PathParameters> | null,
2598
+ data?: any,
2599
+ config?: AxiosRequestConfig
2600
+ ): OperationResponse<Paths.DeleteStep.Responses.$204>
2601
+ /**
2602
+ * searchExecutions - searchExecutions
2603
+ *
2604
+ * Search Workflow Executions by different filters.
2605
+ */
2606
+ 'searchExecutions'(
2607
+ parameters?: Parameters<UnknownParamsObject> | null,
2608
+ data?: Paths.SearchExecutions.RequestBody,
2609
+ config?: AxiosRequestConfig
2610
+ ): OperationResponse<Paths.SearchExecutions.Responses.$200>
2611
+ /**
2612
+ * searchSteps - searchSteps
2613
+ *
2614
+ * Search workflow execution steps by different filters.
2615
+ */
2616
+ 'searchSteps'(
2617
+ parameters?: Parameters<UnknownParamsObject> | null,
2618
+ data?: Paths.SearchSteps.RequestBody,
2619
+ config?: AxiosRequestConfig
2620
+ ): OperationResponse<Paths.SearchSteps.Responses.$200>
2621
+ /**
2622
+ * getClosingReasonExecution - getClosingReasonExecution
2623
+ *
2624
+ * Shows all Closing Reasons defined at the moment of starting the Workflow Execution.
2625
+ * The Closing Reasons shown in the execution are just snapshots
2626
+ * from the state of the Definition when the instance was created.
2627
+ *
2628
+ */
2629
+ 'getClosingReasonExecution'(
2630
+ parameters?: Parameters<Paths.GetClosingReasonExecution.PathParameters> | null,
2631
+ data?: any,
2632
+ config?: AxiosRequestConfig
2633
+ ): OperationResponse<Paths.GetClosingReasonExecution.Responses.$200>
2634
+ /**
2635
+ * startFlowExecution - startFlowExecution
2636
+ *
2637
+ * Starts a new Flow Execution based on a flow template.
2638
+ */
2639
+ 'startFlowExecution'(
2640
+ parameters?: Parameters<UnknownParamsObject> | null,
2641
+ data?: Paths.StartFlowExecution.RequestBody,
2642
+ config?: AxiosRequestConfig
2643
+ ): OperationResponse<Paths.StartFlowExecution.Responses.$201>
2644
+ /**
2645
+ * getFlowExecution - getFlowExecution
2646
+ *
2647
+ * Get a full flow execution, included tasks, phases, edges & analytics.
2648
+ */
2649
+ 'getFlowExecution'(
2650
+ parameters?: Parameters<Paths.GetFlowExecution.PathParameters> | null,
2651
+ data?: any,
2652
+ config?: AxiosRequestConfig
2653
+ ): OperationResponse<Paths.GetFlowExecution.Responses.$200>
2654
+ /**
2655
+ * patchFlowExecution - patchFlowExecution
2656
+ *
2657
+ * Patch flow execution with new assignees, status, analytics & other changes.
2658
+ */
2659
+ 'patchFlowExecution'(
2660
+ parameters?: Parameters<Paths.PatchFlowExecution.PathParameters> | null,
2661
+ data?: Paths.PatchFlowExecution.RequestBody,
2662
+ config?: AxiosRequestConfig
2663
+ ): OperationResponse<Paths.PatchFlowExecution.Responses.$200>
2664
+ /**
2665
+ * deleteFlowExecution - deleteFlowExecution
2666
+ *
2667
+ * Deletes a specific execution of a flow, identified by id. Flow contexts will NOT be deleted.
2668
+ */
2669
+ 'deleteFlowExecution'(
2670
+ parameters?: Parameters<Paths.DeleteFlowExecution.QueryParameters & Paths.DeleteFlowExecution.PathParameters> | null,
2671
+ data?: any,
2672
+ config?: AxiosRequestConfig
2673
+ ): OperationResponse<Paths.DeleteFlowExecution.Responses.$204>
2674
+ /**
2675
+ * searchFlowExecutions - searchFlowExecutions
2676
+ *
2677
+ * Search Flow Executions for a specific Entity.
2678
+ */
2679
+ 'searchFlowExecutions'(
2680
+ parameters?: Parameters<UnknownParamsObject> | null,
2681
+ data?: Paths.SearchFlowExecutions.RequestBody,
2682
+ config?: AxiosRequestConfig
2683
+ ): OperationResponse<Paths.SearchFlowExecutions.Responses.$200>
2684
+ /**
2685
+ * patchTask - patchTask
2686
+ *
2687
+ * Changes various attributes of a flow task, like assignees, status, due date, etc.
2688
+ */
2689
+ 'patchTask'(
2690
+ parameters?: Parameters<Paths.PatchTask.PathParameters> | null,
2691
+ data?: Paths.PatchTask.RequestBody,
2692
+ config?: AxiosRequestConfig
2693
+ ): OperationResponse<Paths.PatchTask.Responses.$200>
2694
+ /**
2695
+ * runTaskAutomation - runTaskAutomation
2696
+ *
2697
+ * Runs configured automation for a flow task
2698
+ */
2699
+ 'runTaskAutomation'(
2700
+ parameters?: Parameters<Paths.RunTaskAutomation.PathParameters> | null,
2701
+ data?: any,
2702
+ config?: AxiosRequestConfig
2703
+ ): OperationResponse<Paths.RunTaskAutomation.Responses.$200>
2704
+ /**
2705
+ * executeTask - executeTask
2706
+ *
2707
+ * Executes any kind of flow task immediately.
2708
+ */
2709
+ 'executeTask'(
2710
+ parameters?: Parameters<Paths.ExecuteTask.PathParameters> | null,
2711
+ data?: any,
2712
+ config?: AxiosRequestConfig
2713
+ ): OperationResponse<Paths.ExecuteTask.Responses.$200>
2714
+ /**
2715
+ * patchPhase - patchPhase
2716
+ *
2717
+ * Apply updates to a phase within flow execution
2718
+ */
2719
+ 'patchPhase'(
2720
+ parameters?: Parameters<Paths.PatchPhase.PathParameters> | null,
2721
+ data?: Paths.PatchPhase.RequestBody,
2722
+ config?: AxiosRequestConfig
2723
+ ): OperationResponse<Paths.PatchPhase.Responses.$200>
2724
+ /**
2725
+ * addTask - addTask
2726
+ *
2727
+ * Create a new task in current workflow execution.
2728
+ */
2729
+ 'addTask'(
2730
+ parameters?: Parameters<Paths.AddTask.PathParameters> | null,
2731
+ data?: Paths.AddTask.RequestBody,
2732
+ config?: AxiosRequestConfig
2733
+ ): OperationResponse<Paths.AddTask.Responses.$201>
2734
+ /**
2735
+ * cancelTaskSchedule - cancelTaskSchedule
2736
+ *
2737
+ * Cancels a scheduled task, deleting the schedule and marking the task as skipped.
2738
+ */
2739
+ 'cancelTaskSchedule'(
2740
+ parameters?: Parameters<Paths.CancelTaskSchedule.PathParameters> | null,
2741
+ data?: any,
2742
+ config?: AxiosRequestConfig
2743
+ ): OperationResponse<Paths.CancelTaskSchedule.Responses.$204>
2744
+ /**
2745
+ * runTaskScheduleNow - runTaskScheduleNow
2746
+ *
2747
+ * Cancels the pending schedule for a task and immediately triggers its automation execution.
2748
+ */
2749
+ 'runTaskScheduleNow'(
2750
+ parameters?: Parameters<Paths.RunTaskScheduleNow.PathParameters> | null,
2751
+ data?: any,
2752
+ config?: AxiosRequestConfig
2753
+ ): OperationResponse<Paths.RunTaskScheduleNow.Responses.$200>
2754
+ /**
2755
+ * cancelSchedule - cancelSchedule
2756
+ *
2757
+ * Cancels a flow schedule, marking it as canceled.
2758
+ *
2759
+ * **Deprecated**: Use DELETE /v2/flows/executions/{execution_id}/tasks/{task_id}/schedule instead.
2760
+ *
2761
+ */
2762
+ 'cancelSchedule'(
2763
+ parameters?: Parameters<Paths.CancelSchedule.PathParameters> | null,
2764
+ data?: any,
2765
+ config?: AxiosRequestConfig
2766
+ ): OperationResponse<Paths.CancelSchedule.Responses.$204>
2767
+ }
2768
+
2769
+ interface PathsDictionary {
2770
+ ['/v1/workflows/executions']: {
2771
+ /**
2772
+ * getExecutions - getExecutions
2773
+ *
2774
+ * Retrieve Workflow Executions. Optionally, you can filter them by context & schema. Please be aware, these executions are more light weight - steps are not loaded with all information.
2775
+ */
2776
+ 'get'(
2777
+ parameters?: Parameters<Paths.GetExecutions.QueryParameters> | null,
2778
+ data?: any,
2779
+ config?: AxiosRequestConfig
2780
+ ): OperationResponse<Paths.GetExecutions.Responses.$200>
2781
+ /**
2782
+ * createExecution - createExecution
2783
+ *
2784
+ * Create a Workflow Execution. Start a new workflow execution, based on a workflow definition (template).
2785
+ */
2786
+ 'post'(
2787
+ parameters?: Parameters<UnknownParamsObject> | null,
2788
+ data?: Paths.CreateExecution.RequestBody,
2789
+ config?: AxiosRequestConfig
2790
+ ): OperationResponse<Paths.CreateExecution.Responses.$201>
2791
+ }
2792
+ ['/v1/workflows/executions/{executionId}']: {
2793
+ /**
2794
+ * getExecution - getExecution
2795
+ *
2796
+ * Get a full workflow execution, included steps information, by execution id.
2797
+ */
2798
+ 'get'(
2799
+ parameters?: Parameters<Paths.GetExecution.PathParameters> | null,
2800
+ data?: any,
2801
+ config?: AxiosRequestConfig
2802
+ ): OperationResponse<Paths.GetExecution.Responses.$200>
2803
+ /**
2804
+ * updateExecution - updateExecution
2805
+ *
2806
+ * Patches updates like assignees, status, closingReason for a single Workflow Execution.
2807
+ */
2808
+ 'patch'(
2809
+ parameters?: Parameters<Paths.UpdateExecution.PathParameters> | null,
2810
+ data?: Paths.UpdateExecution.RequestBody,
2811
+ config?: AxiosRequestConfig
2812
+ ): OperationResponse<Paths.UpdateExecution.Responses.$204>
2813
+ /**
2814
+ * deleteExecution - deleteExecution
2815
+ *
2816
+ * Delete workflow execution by id. Workflow contexts will NOT be deleted.
2817
+ */
2818
+ 'delete'(
2819
+ parameters?: Parameters<Paths.DeleteExecution.PathParameters> | null,
2820
+ data?: any,
2821
+ config?: AxiosRequestConfig
2822
+ ): OperationResponse<Paths.DeleteExecution.Responses.$204>
2823
+ }
2824
+ ['/v1/workflows/executions/{executionId}/steps']: {
2825
+ /**
2826
+ * createStep - createStep
2827
+ *
2828
+ * Create a new step in current workflow execution.
2829
+ */
2830
+ 'post'(
2831
+ parameters?: Parameters<Paths.CreateStep.PathParameters> | null,
2832
+ data?: Paths.CreateStep.RequestBody,
2833
+ config?: AxiosRequestConfig
2834
+ ): OperationResponse<Paths.CreateStep.Responses.$201>
2835
+ }
2836
+ ['/v1/workflows/executions/{executionId}/steps/{stepId}']: {
2837
+ /**
2838
+ * updateStep - updateStep
2839
+ *
2840
+ * Patches various changes to a workflow execution step.
2841
+ */
2842
+ 'patch'(
2843
+ parameters?: Parameters<Paths.UpdateStep.PathParameters> | null,
2844
+ data?: Paths.UpdateStep.RequestBody,
2845
+ config?: AxiosRequestConfig
2846
+ ): OperationResponse<Paths.UpdateStep.Responses.$200>
2847
+ /**
2848
+ * deleteStep - deleteStep
2849
+ *
2850
+ * Deletes a step from a workflow execution.
2851
+ */
2852
+ 'delete'(
2853
+ parameters?: Parameters<Paths.DeleteStep.PathParameters> | null,
2854
+ data?: any,
2855
+ config?: AxiosRequestConfig
2856
+ ): OperationResponse<Paths.DeleteStep.Responses.$204>
2857
+ }
2858
+ ['/v1/workflows/executions/search']: {
2859
+ /**
2860
+ * searchExecutions - searchExecutions
2861
+ *
2862
+ * Search Workflow Executions by different filters.
2863
+ */
2864
+ 'post'(
2865
+ parameters?: Parameters<UnknownParamsObject> | null,
2866
+ data?: Paths.SearchExecutions.RequestBody,
2867
+ config?: AxiosRequestConfig
2868
+ ): OperationResponse<Paths.SearchExecutions.Responses.$200>
2869
+ }
2870
+ ['/v1/workflows/executions/steps/search']: {
2871
+ /**
2872
+ * searchSteps - searchSteps
2873
+ *
2874
+ * Search workflow execution steps by different filters.
2875
+ */
2876
+ 'post'(
2877
+ parameters?: Parameters<UnknownParamsObject> | null,
2878
+ data?: Paths.SearchSteps.RequestBody,
2879
+ config?: AxiosRequestConfig
2880
+ ): OperationResponse<Paths.SearchSteps.Responses.$200>
2881
+ }
2882
+ ['/v1/workflows/executions/{executionId}/closing-reasons']: {
2883
+ /**
2884
+ * getClosingReasonExecution - getClosingReasonExecution
2885
+ *
2886
+ * Shows all Closing Reasons defined at the moment of starting the Workflow Execution.
2887
+ * The Closing Reasons shown in the execution are just snapshots
2888
+ * from the state of the Definition when the instance was created.
2889
+ *
2890
+ */
2891
+ 'get'(
2892
+ parameters?: Parameters<Paths.GetClosingReasonExecution.PathParameters> | null,
2893
+ data?: any,
2894
+ config?: AxiosRequestConfig
2895
+ ): OperationResponse<Paths.GetClosingReasonExecution.Responses.$200>
2896
+ }
2897
+ ['/v2/flows/executions']: {
2898
+ /**
2899
+ * startFlowExecution - startFlowExecution
2900
+ *
2901
+ * Starts a new Flow Execution based on a flow template.
2902
+ */
2903
+ 'post'(
2904
+ parameters?: Parameters<UnknownParamsObject> | null,
2905
+ data?: Paths.StartFlowExecution.RequestBody,
2906
+ config?: AxiosRequestConfig
2907
+ ): OperationResponse<Paths.StartFlowExecution.Responses.$201>
2908
+ }
2909
+ ['/v2/flows/executions/{execution_id}']: {
2910
+ /**
2911
+ * getFlowExecution - getFlowExecution
2912
+ *
2913
+ * Get a full flow execution, included tasks, phases, edges & analytics.
2914
+ */
2915
+ 'get'(
2916
+ parameters?: Parameters<Paths.GetFlowExecution.PathParameters> | null,
2917
+ data?: any,
2918
+ config?: AxiosRequestConfig
2919
+ ): OperationResponse<Paths.GetFlowExecution.Responses.$200>
2920
+ /**
2921
+ * patchFlowExecution - patchFlowExecution
2922
+ *
2923
+ * Patch flow execution with new assignees, status, analytics & other changes.
2924
+ */
2925
+ 'patch'(
2926
+ parameters?: Parameters<Paths.PatchFlowExecution.PathParameters> | null,
2927
+ data?: Paths.PatchFlowExecution.RequestBody,
2928
+ config?: AxiosRequestConfig
2929
+ ): OperationResponse<Paths.PatchFlowExecution.Responses.$200>
2930
+ /**
2931
+ * deleteFlowExecution - deleteFlowExecution
2932
+ *
2933
+ * Deletes a specific execution of a flow, identified by id. Flow contexts will NOT be deleted.
2934
+ */
2935
+ 'delete'(
2936
+ parameters?: Parameters<Paths.DeleteFlowExecution.QueryParameters & Paths.DeleteFlowExecution.PathParameters> | null,
2937
+ data?: any,
2938
+ config?: AxiosRequestConfig
2939
+ ): OperationResponse<Paths.DeleteFlowExecution.Responses.$204>
2940
+ }
2941
+ ['/v2/flows/executions:search']: {
2942
+ /**
2943
+ * searchFlowExecutions - searchFlowExecutions
2944
+ *
2945
+ * Search Flow Executions for a specific Entity.
2946
+ */
2947
+ 'post'(
2948
+ parameters?: Parameters<UnknownParamsObject> | null,
2949
+ data?: Paths.SearchFlowExecutions.RequestBody,
2950
+ config?: AxiosRequestConfig
2951
+ ): OperationResponse<Paths.SearchFlowExecutions.Responses.$200>
2952
+ }
2953
+ ['/v2/flows/executions/{execution_id}/tasks/{task_id}']: {
2954
+ /**
2955
+ * patchTask - patchTask
2956
+ *
2957
+ * Changes various attributes of a flow task, like assignees, status, due date, etc.
2958
+ */
2959
+ 'patch'(
2960
+ parameters?: Parameters<Paths.PatchTask.PathParameters> | null,
2961
+ data?: Paths.PatchTask.RequestBody,
2962
+ config?: AxiosRequestConfig
2963
+ ): OperationResponse<Paths.PatchTask.Responses.$200>
2964
+ }
2965
+ ['/v2/flows/executions/{execution_id}/tasks/{task_id}/automation:run']: {
2966
+ /**
2967
+ * runTaskAutomation - runTaskAutomation
2968
+ *
2969
+ * Runs configured automation for a flow task
2970
+ */
2971
+ 'post'(
2972
+ parameters?: Parameters<Paths.RunTaskAutomation.PathParameters> | null,
2973
+ data?: any,
2974
+ config?: AxiosRequestConfig
2975
+ ): OperationResponse<Paths.RunTaskAutomation.Responses.$200>
2976
+ }
2977
+ ['/v2/flows/executions/{execution_id}/tasks/{task_id}/execute']: {
2978
+ /**
2979
+ * executeTask - executeTask
2980
+ *
2981
+ * Executes any kind of flow task immediately.
2982
+ */
2983
+ 'post'(
2984
+ parameters?: Parameters<Paths.ExecuteTask.PathParameters> | null,
2985
+ data?: any,
2986
+ config?: AxiosRequestConfig
2987
+ ): OperationResponse<Paths.ExecuteTask.Responses.$200>
2988
+ }
2989
+ ['/v2/flows/executions/{execution_id}/phases/{phase_id}']: {
2990
+ /**
2991
+ * patchPhase - patchPhase
2992
+ *
2993
+ * Apply updates to a phase within flow execution
2994
+ */
2995
+ 'patch'(
2996
+ parameters?: Parameters<Paths.PatchPhase.PathParameters> | null,
2997
+ data?: Paths.PatchPhase.RequestBody,
2998
+ config?: AxiosRequestConfig
2999
+ ): OperationResponse<Paths.PatchPhase.Responses.$200>
3000
+ }
3001
+ ['/v2/flows/executions/{execution_id}/tasks']: {
3002
+ /**
3003
+ * addTask - addTask
3004
+ *
3005
+ * Create a new task in current workflow execution.
3006
+ */
3007
+ 'post'(
3008
+ parameters?: Parameters<Paths.AddTask.PathParameters> | null,
3009
+ data?: Paths.AddTask.RequestBody,
3010
+ config?: AxiosRequestConfig
3011
+ ): OperationResponse<Paths.AddTask.Responses.$201>
3012
+ }
3013
+ ['/v2/flows/executions/{execution_id}/tasks/{task_id}/schedule']: {
3014
+ /**
3015
+ * cancelTaskSchedule - cancelTaskSchedule
3016
+ *
3017
+ * Cancels a scheduled task, deleting the schedule and marking the task as skipped.
3018
+ */
3019
+ 'delete'(
3020
+ parameters?: Parameters<Paths.CancelTaskSchedule.PathParameters> | null,
3021
+ data?: any,
3022
+ config?: AxiosRequestConfig
3023
+ ): OperationResponse<Paths.CancelTaskSchedule.Responses.$204>
3024
+ }
3025
+ ['/v2/flows/executions/{execution_id}/tasks/{task_id}/schedule/run-now']: {
3026
+ /**
3027
+ * runTaskScheduleNow - runTaskScheduleNow
3028
+ *
3029
+ * Cancels the pending schedule for a task and immediately triggers its automation execution.
3030
+ */
3031
+ 'post'(
3032
+ parameters?: Parameters<Paths.RunTaskScheduleNow.PathParameters> | null,
3033
+ data?: any,
3034
+ config?: AxiosRequestConfig
3035
+ ): OperationResponse<Paths.RunTaskScheduleNow.Responses.$200>
3036
+ }
3037
+ ['/v2/flows/executions/{execution_id}/schedules/{schedule_id}']: {
3038
+ /**
3039
+ * cancelSchedule - cancelSchedule
3040
+ *
3041
+ * Cancels a flow schedule, marking it as canceled.
3042
+ *
3043
+ * **Deprecated**: Use DELETE /v2/flows/executions/{execution_id}/tasks/{task_id}/schedule instead.
3044
+ *
3045
+ */
3046
+ 'post'(
3047
+ parameters?: Parameters<Paths.CancelSchedule.PathParameters> | null,
3048
+ data?: any,
3049
+ config?: AxiosRequestConfig
3050
+ ): OperationResponse<Paths.CancelSchedule.Responses.$204>
3051
+ }
3052
+ }
3053
+
3054
+ type Client = OpenAPIClient<OperationMethods, PathsDictionary>
3055
+
3056
+
3057
+ type ActionSchedule = Components.Schemas.ActionSchedule;
3058
+ type AddTaskReq = Components.Schemas.AddTaskReq;
3059
+ type AgentConfig = Components.Schemas.AgentConfig;
3060
+ type AgentExecutionInfo = Components.Schemas.AgentExecutionInfo;
3061
+ type AiAgentTask = Components.Schemas.AiAgentTask;
3062
+ type AnalyticsInfo = Components.Schemas.AnalyticsInfo;
3063
+ type Assignees = Components.Schemas.Assignees;
3064
+ type AutomationConfig = Components.Schemas.AutomationConfig;
3065
+ type AutomationInfo = Components.Schemas.AutomationInfo;
3066
+ type AutomationInputContext = Components.Schemas.AutomationInputContext;
3067
+ type AutomationTask = Components.Schemas.AutomationTask;
3068
+ type ClosingReason = Components.Schemas.ClosingReason;
3069
+ type ClosingReasonResp = Components.Schemas.ClosingReasonResp;
3070
+ type Condition = Components.Schemas.Condition;
3071
+ type ConditionId = Components.Schemas.ConditionId;
3072
+ type CreateStepReq = Components.Schemas.CreateStepReq;
3073
+ type DecisionTask = Components.Schemas.DecisionTask;
3074
+ type DelayedSchedule = Components.Schemas.DelayedSchedule;
3075
+ type DueDateConfig = Components.Schemas.DueDateConfig;
3076
+ type DynamicDueDate = Components.Schemas.DynamicDueDate;
3077
+ type ECPDetails = Components.Schemas.ECPDetails;
3078
+ type Edge = Components.Schemas.Edge;
3079
+ type EnableRequirement = Components.Schemas.EnableRequirement;
3080
+ type EntityRef = Components.Schemas.EntityRef;
3081
+ type EntitySync = Components.Schemas.EntitySync;
3082
+ type ErrorResp = Components.Schemas.ErrorResp;
3083
+ type EvaluationSource = Components.Schemas.EvaluationSource;
3084
+ type ExecutionPaginationDynamo = Components.Schemas.ExecutionPaginationDynamo;
3085
+ type Flow = Components.Schemas.Flow;
3086
+ type FlowClosingReason = Components.Schemas.FlowClosingReason;
3087
+ type FlowContext = Components.Schemas.FlowContext;
3088
+ type FlowExecution = Components.Schemas.FlowExecution;
3089
+ type FlowExecutionId = Components.Schemas.FlowExecutionId;
3090
+ type FlowSlim = Components.Schemas.FlowSlim;
3091
+ type FlowTemplateId = Components.Schemas.FlowTemplateId;
3092
+ type FlowTrigger = Components.Schemas.FlowTrigger;
3093
+ type ImmediateSchedule = Components.Schemas.ImmediateSchedule;
3094
+ type ItemType = Components.Schemas.ItemType;
3095
+ type LastEvaluatedKey = Components.Schemas.LastEvaluatedKey;
3096
+ type LoopConfig = Components.Schemas.LoopConfig;
3097
+ type LoopInfo = Components.Schemas.LoopInfo;
3098
+ type ManualTask = Components.Schemas.ManualTask;
3099
+ type Operator = Components.Schemas.Operator;
3100
+ type PartnerDetails = Components.Schemas.PartnerDetails;
3101
+ type PatchFlowReq = Components.Schemas.PatchFlowReq;
3102
+ type PatchPhaseReq = Components.Schemas.PatchPhaseReq;
3103
+ type PatchTaskReq = Components.Schemas.PatchTaskReq;
3104
+ type Phase = Components.Schemas.Phase;
3105
+ type PhaseId = Components.Schemas.PhaseId;
3106
+ type PhaseInEntity = Components.Schemas.PhaseInEntity;
3107
+ type RelativeSchedule = Components.Schemas.RelativeSchedule;
3108
+ type SearchExecutionsReq = Components.Schemas.SearchExecutionsReq;
3109
+ type SearchExecutionsResp = Components.Schemas.SearchExecutionsResp;
3110
+ type SearchFlowsReq = Components.Schemas.SearchFlowsReq;
3111
+ type SearchPagination = Components.Schemas.SearchPagination;
3112
+ type SearchSorting = Components.Schemas.SearchSorting;
3113
+ type SearchStepsReq = Components.Schemas.SearchStepsReq;
3114
+ type SearchStepsResp = Components.Schemas.SearchStepsResp;
3115
+ type Section = Components.Schemas.Section;
3116
+ type SectionSimplified = Components.Schemas.SectionSimplified;
3117
+ type SectionStatus = Components.Schemas.SectionStatus;
3118
+ type StartFlowReq = Components.Schemas.StartFlowReq;
3119
+ type Statement = Components.Schemas.Statement;
3120
+ type Step = Components.Schemas.Step;
3121
+ type StepDescription = Components.Schemas.StepDescription;
3122
+ type StepExtended = Components.Schemas.StepExtended;
3123
+ type StepId = Components.Schemas.StepId;
3124
+ type StepJourney = Components.Schemas.StepJourney;
3125
+ type StepPositionAt = Components.Schemas.StepPositionAt;
3126
+ type StepRequirement = Components.Schemas.StepRequirement;
3127
+ type StepSimplified = Components.Schemas.StepSimplified;
3128
+ type StepStatus = Components.Schemas.StepStatus;
3129
+ type StepType = Components.Schemas.StepType;
3130
+ type Task = Components.Schemas.Task;
3131
+ type TaskBase = Components.Schemas.TaskBase;
3132
+ type TaskId = Components.Schemas.TaskId;
3133
+ type TaskType = Components.Schemas.TaskType;
3134
+ type TimeUnit = Components.Schemas.TimeUnit;
3135
+ type TriggerMode = Components.Schemas.TriggerMode;
3136
+ type TriggerType = Components.Schemas.TriggerType;
3137
+ type UpdateEntityAttributes = Components.Schemas.UpdateEntityAttributes;
3138
+ type UpdateStepReq = Components.Schemas.UpdateStepReq;
3139
+ type UpdateStepResp = Components.Schemas.UpdateStepResp;
3140
+ type UserId = Components.Schemas.UserId;
3141
+ type VariableAssignment = Components.Schemas.VariableAssignment;
3142
+ type WorkflowContext = Components.Schemas.WorkflowContext;
3143
+ type WorkflowExecution = Components.Schemas.WorkflowExecution;
3144
+ type WorkflowExecutionBase = Components.Schemas.WorkflowExecutionBase;
3145
+ type WorkflowExecutionCreateReq = Components.Schemas.WorkflowExecutionCreateReq;
3146
+ type WorkflowExecutionSlim = Components.Schemas.WorkflowExecutionSlim;
3147
+ type WorkflowExecutionUpdateReq = Components.Schemas.WorkflowExecutionUpdateReq;
3148
+ type WorkflowInEntity = Components.Schemas.WorkflowInEntity;
3149
+ type WorkflowStatus = Components.Schemas.WorkflowStatus;
3150
+
3151
+ export { type PhaseId as $, type ActionSchedule as A, type ExecutionPaginationDynamo as B, type Client as C, type DecisionTask as D, type ECPDetails as E, type Flow as F, type FlowClosingReason as G, type FlowContext as H, type FlowExecution as I, type FlowExecutionId as J, type FlowSlim as K, type FlowTemplateId as L, type FlowTrigger as M, type ImmediateSchedule as N, type OperationMethods as O, Paths as P, type ItemType as Q, type LastEvaluatedKey as R, type LoopConfig as S, type LoopInfo as T, type ManualTask as U, type Operator as V, type PartnerDetails as W, type PatchFlowReq as X, type PatchPhaseReq as Y, type PatchTaskReq as Z, type Phase as _, Components as a, type PhaseInEntity as a0, type RelativeSchedule as a1, type SearchExecutionsReq as a2, type SearchExecutionsResp as a3, type SearchFlowsReq as a4, type SearchPagination as a5, type SearchSorting as a6, type SearchStepsReq as a7, type SearchStepsResp as a8, type Section as a9, type WorkflowContext as aA, type WorkflowExecution as aB, type WorkflowExecutionBase as aC, type WorkflowExecutionCreateReq as aD, type WorkflowExecutionSlim as aE, type WorkflowExecutionUpdateReq as aF, type WorkflowInEntity as aG, type WorkflowStatus as aH, type SectionSimplified as aa, type SectionStatus as ab, type StartFlowReq as ac, type Statement as ad, type Step as ae, type StepDescription as af, type StepExtended as ag, type StepId as ah, type StepJourney as ai, type StepPositionAt as aj, type StepRequirement as ak, type StepSimplified as al, type StepStatus as am, type StepType as an, type Task as ao, type TaskBase as ap, type TaskId as aq, type TaskType as ar, type TimeUnit as as, type TriggerMode as at, type TriggerType as au, type UpdateEntityAttributes as av, type UpdateStepReq as aw, type UpdateStepResp as ax, type UserId as ay, type VariableAssignment as az, type PathsDictionary as b, type AddTaskReq as c, type AgentConfig as d, type AgentExecutionInfo as e, type AiAgentTask as f, type AnalyticsInfo as g, type Assignees as h, type AutomationConfig as i, type AutomationInfo as j, type AutomationInputContext as k, type AutomationTask as l, type ClosingReason as m, type ClosingReasonResp as n, type Condition as o, type ConditionId as p, type CreateStepReq as q, type DelayedSchedule as r, type DueDateConfig as s, type DynamicDueDate as t, type Edge as u, type EnableRequirement as v, type EntityRef as w, type EntitySync as x, type ErrorResp as y, type EvaluationSource as z };