@epilot/sdk 2.0.0-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (381) hide show
  1. package/README.md +294 -0
  2. package/dist/access-token-MYDOBCIY.cjs +89 -0
  3. package/dist/access-token-Y5JR7PRG.js +89 -0
  4. package/dist/access-token.d-C2qnueDV.d.cts +553 -0
  5. package/dist/access-token.d-C2qnueDV.d.ts +553 -0
  6. package/dist/address-3RQRG3MK.js +84 -0
  7. package/dist/address-LQUTDOUA.cjs +84 -0
  8. package/dist/address-suggestions-PEKSA7B2.cjs +132 -0
  9. package/dist/address-suggestions-QNK5JWNH.js +132 -0
  10. package/dist/address-suggestions.d-CewXYNYH.d.cts +340 -0
  11. package/dist/address-suggestions.d-CewXYNYH.d.ts +340 -0
  12. package/dist/address.d-DP_aE2ex.d.cts +438 -0
  13. package/dist/address.d-DP_aE2ex.d.ts +438 -0
  14. package/dist/ai-agents-MO4PK2RJ.cjs +215 -0
  15. package/dist/ai-agents-OHP2F243.js +215 -0
  16. package/dist/ai-agents.d-vG-1utqk.d.cts +1340 -0
  17. package/dist/ai-agents.d-vG-1utqk.d.ts +1340 -0
  18. package/dist/apis/access-token.cjs +33 -0
  19. package/dist/apis/access-token.d.cts +18 -0
  20. package/dist/apis/access-token.d.ts +18 -0
  21. package/dist/apis/access-token.js +33 -0
  22. package/dist/apis/address-suggestions.cjs +33 -0
  23. package/dist/apis/address-suggestions.d.cts +18 -0
  24. package/dist/apis/address-suggestions.d.ts +18 -0
  25. package/dist/apis/address-suggestions.js +33 -0
  26. package/dist/apis/address.cjs +33 -0
  27. package/dist/apis/address.d.cts +18 -0
  28. package/dist/apis/address.d.ts +18 -0
  29. package/dist/apis/address.js +33 -0
  30. package/dist/apis/ai-agents.cjs +33 -0
  31. package/dist/apis/ai-agents.d.cts +18 -0
  32. package/dist/apis/ai-agents.d.ts +18 -0
  33. package/dist/apis/ai-agents.js +33 -0
  34. package/dist/apis/app.cjs +33 -0
  35. package/dist/apis/app.d.cts +18 -0
  36. package/dist/apis/app.d.ts +18 -0
  37. package/dist/apis/app.js +33 -0
  38. package/dist/apis/audit-logs.cjs +33 -0
  39. package/dist/apis/audit-logs.d.cts +18 -0
  40. package/dist/apis/audit-logs.d.ts +18 -0
  41. package/dist/apis/audit-logs.js +33 -0
  42. package/dist/apis/automation.cjs +33 -0
  43. package/dist/apis/automation.d.cts +18 -0
  44. package/dist/apis/automation.d.ts +18 -0
  45. package/dist/apis/automation.js +33 -0
  46. package/dist/apis/billing.cjs +33 -0
  47. package/dist/apis/billing.d.cts +18 -0
  48. package/dist/apis/billing.d.ts +18 -0
  49. package/dist/apis/billing.js +33 -0
  50. package/dist/apis/blueprint-manifest.cjs +33 -0
  51. package/dist/apis/blueprint-manifest.d.cts +18 -0
  52. package/dist/apis/blueprint-manifest.d.ts +18 -0
  53. package/dist/apis/blueprint-manifest.js +33 -0
  54. package/dist/apis/consent.cjs +33 -0
  55. package/dist/apis/consent.d.cts +18 -0
  56. package/dist/apis/consent.d.ts +18 -0
  57. package/dist/apis/consent.js +33 -0
  58. package/dist/apis/customer-portal.cjs +33 -0
  59. package/dist/apis/customer-portal.d.cts +18 -0
  60. package/dist/apis/customer-portal.d.ts +18 -0
  61. package/dist/apis/customer-portal.js +33 -0
  62. package/dist/apis/data-management.cjs +33 -0
  63. package/dist/apis/data-management.d.cts +18 -0
  64. package/dist/apis/data-management.d.ts +18 -0
  65. package/dist/apis/data-management.js +33 -0
  66. package/dist/apis/deduplication.cjs +33 -0
  67. package/dist/apis/deduplication.d.cts +18 -0
  68. package/dist/apis/deduplication.d.ts +18 -0
  69. package/dist/apis/deduplication.js +33 -0
  70. package/dist/apis/design.cjs +33 -0
  71. package/dist/apis/design.d.cts +18 -0
  72. package/dist/apis/design.d.ts +18 -0
  73. package/dist/apis/design.js +33 -0
  74. package/dist/apis/discussion.cjs +33 -0
  75. package/dist/apis/discussion.d.cts +18 -0
  76. package/dist/apis/discussion.d.ts +18 -0
  77. package/dist/apis/discussion.js +33 -0
  78. package/dist/apis/document.cjs +33 -0
  79. package/dist/apis/document.d.cts +18 -0
  80. package/dist/apis/document.d.ts +18 -0
  81. package/dist/apis/document.js +33 -0
  82. package/dist/apis/email-settings.cjs +33 -0
  83. package/dist/apis/email-settings.d.cts +18 -0
  84. package/dist/apis/email-settings.d.ts +18 -0
  85. package/dist/apis/email-settings.js +33 -0
  86. package/dist/apis/email-template.cjs +33 -0
  87. package/dist/apis/email-template.d.cts +18 -0
  88. package/dist/apis/email-template.d.ts +18 -0
  89. package/dist/apis/email-template.js +33 -0
  90. package/dist/apis/entity-mapping.cjs +33 -0
  91. package/dist/apis/entity-mapping.d.cts +18 -0
  92. package/dist/apis/entity-mapping.d.ts +18 -0
  93. package/dist/apis/entity-mapping.js +33 -0
  94. package/dist/apis/entity.cjs +33 -0
  95. package/dist/apis/entity.d.cts +18 -0
  96. package/dist/apis/entity.d.ts +18 -0
  97. package/dist/apis/entity.js +33 -0
  98. package/dist/apis/environments.cjs +33 -0
  99. package/dist/apis/environments.d.cts +18 -0
  100. package/dist/apis/environments.d.ts +18 -0
  101. package/dist/apis/environments.js +33 -0
  102. package/dist/apis/erp-integration.cjs +33 -0
  103. package/dist/apis/erp-integration.d.cts +18 -0
  104. package/dist/apis/erp-integration.d.ts +18 -0
  105. package/dist/apis/erp-integration.js +33 -0
  106. package/dist/apis/event-catalog.cjs +33 -0
  107. package/dist/apis/event-catalog.d.cts +18 -0
  108. package/dist/apis/event-catalog.d.ts +18 -0
  109. package/dist/apis/event-catalog.js +33 -0
  110. package/dist/apis/file.cjs +33 -0
  111. package/dist/apis/file.d.cts +18 -0
  112. package/dist/apis/file.d.ts +18 -0
  113. package/dist/apis/file.js +33 -0
  114. package/dist/apis/iban.cjs +33 -0
  115. package/dist/apis/iban.d.cts +18 -0
  116. package/dist/apis/iban.d.ts +18 -0
  117. package/dist/apis/iban.js +33 -0
  118. package/dist/apis/journey.cjs +33 -0
  119. package/dist/apis/journey.d.cts +18 -0
  120. package/dist/apis/journey.d.ts +18 -0
  121. package/dist/apis/journey.js +33 -0
  122. package/dist/apis/kanban.cjs +33 -0
  123. package/dist/apis/kanban.d.cts +18 -0
  124. package/dist/apis/kanban.d.ts +18 -0
  125. package/dist/apis/kanban.js +33 -0
  126. package/dist/apis/message.cjs +33 -0
  127. package/dist/apis/message.d.cts +18 -0
  128. package/dist/apis/message.d.ts +18 -0
  129. package/dist/apis/message.js +33 -0
  130. package/dist/apis/metering.cjs +33 -0
  131. package/dist/apis/metering.d.cts +18 -0
  132. package/dist/apis/metering.d.ts +18 -0
  133. package/dist/apis/metering.js +33 -0
  134. package/dist/apis/notes.cjs +33 -0
  135. package/dist/apis/notes.d.cts +18 -0
  136. package/dist/apis/notes.d.ts +18 -0
  137. package/dist/apis/notes.js +33 -0
  138. package/dist/apis/notification.cjs +33 -0
  139. package/dist/apis/notification.d.cts +18 -0
  140. package/dist/apis/notification.d.ts +18 -0
  141. package/dist/apis/notification.js +33 -0
  142. package/dist/apis/organization.cjs +33 -0
  143. package/dist/apis/organization.d.cts +18 -0
  144. package/dist/apis/organization.d.ts +18 -0
  145. package/dist/apis/organization.js +33 -0
  146. package/dist/apis/partner-directory.cjs +33 -0
  147. package/dist/apis/partner-directory.d.cts +18 -0
  148. package/dist/apis/partner-directory.d.ts +18 -0
  149. package/dist/apis/partner-directory.js +33 -0
  150. package/dist/apis/permissions.cjs +33 -0
  151. package/dist/apis/permissions.d.cts +18 -0
  152. package/dist/apis/permissions.d.ts +18 -0
  153. package/dist/apis/permissions.js +33 -0
  154. package/dist/apis/pricing-tier.cjs +33 -0
  155. package/dist/apis/pricing-tier.d.cts +18 -0
  156. package/dist/apis/pricing-tier.d.ts +18 -0
  157. package/dist/apis/pricing-tier.js +33 -0
  158. package/dist/apis/pricing.cjs +33 -0
  159. package/dist/apis/pricing.d.cts +18 -0
  160. package/dist/apis/pricing.d.ts +18 -0
  161. package/dist/apis/pricing.js +33 -0
  162. package/dist/apis/purpose.cjs +33 -0
  163. package/dist/apis/purpose.d.cts +18 -0
  164. package/dist/apis/purpose.d.ts +18 -0
  165. package/dist/apis/purpose.js +33 -0
  166. package/dist/apis/sandbox.cjs +33 -0
  167. package/dist/apis/sandbox.d.cts +18 -0
  168. package/dist/apis/sandbox.d.ts +18 -0
  169. package/dist/apis/sandbox.js +33 -0
  170. package/dist/apis/submission.cjs +33 -0
  171. package/dist/apis/submission.d.cts +18 -0
  172. package/dist/apis/submission.d.ts +18 -0
  173. package/dist/apis/submission.js +33 -0
  174. package/dist/apis/targeting.cjs +33 -0
  175. package/dist/apis/targeting.d.cts +18 -0
  176. package/dist/apis/targeting.d.ts +18 -0
  177. package/dist/apis/targeting.js +33 -0
  178. package/dist/apis/template-variables.cjs +33 -0
  179. package/dist/apis/template-variables.d.cts +18 -0
  180. package/dist/apis/template-variables.d.ts +18 -0
  181. package/dist/apis/template-variables.js +33 -0
  182. package/dist/apis/user.cjs +33 -0
  183. package/dist/apis/user.d.cts +18 -0
  184. package/dist/apis/user.d.ts +18 -0
  185. package/dist/apis/user.js +33 -0
  186. package/dist/apis/validation-rules.cjs +33 -0
  187. package/dist/apis/validation-rules.d.cts +18 -0
  188. package/dist/apis/validation-rules.d.ts +18 -0
  189. package/dist/apis/validation-rules.js +33 -0
  190. package/dist/apis/webhooks.cjs +33 -0
  191. package/dist/apis/webhooks.d.cts +18 -0
  192. package/dist/apis/webhooks.d.ts +18 -0
  193. package/dist/apis/webhooks.js +33 -0
  194. package/dist/apis/workflow-definition.cjs +33 -0
  195. package/dist/apis/workflow-definition.d.cts +18 -0
  196. package/dist/apis/workflow-definition.d.ts +18 -0
  197. package/dist/apis/workflow-definition.js +33 -0
  198. package/dist/apis/workflow.cjs +33 -0
  199. package/dist/apis/workflow.d.cts +18 -0
  200. package/dist/apis/workflow.d.ts +18 -0
  201. package/dist/apis/workflow.js +33 -0
  202. package/dist/app-UUTBO3WJ.js +573 -0
  203. package/dist/app-XJGY6SHO.cjs +573 -0
  204. package/dist/app.d-Uncn387s.d.cts +3370 -0
  205. package/dist/app.d-Uncn387s.d.ts +3370 -0
  206. package/dist/audit-logs-4IJYIOXF.js +55 -0
  207. package/dist/audit-logs-UWLCPBB4.cjs +55 -0
  208. package/dist/audit-logs.d-BxZqONu5.d.cts +288 -0
  209. package/dist/audit-logs.d-BxZqONu5.d.ts +288 -0
  210. package/dist/automation-4UQADTDO.cjs +282 -0
  211. package/dist/automation-PVXTQLZX.js +282 -0
  212. package/dist/automation.d-BteCzeFn.d.cts +4921 -0
  213. package/dist/automation.d-BteCzeFn.d.ts +4921 -0
  214. package/dist/billing-FI4V4UX5.cjs +175 -0
  215. package/dist/billing-OMWNJHGW.js +175 -0
  216. package/dist/billing.d-BH4__05Y.d.cts +994 -0
  217. package/dist/billing.d-BH4__05Y.d.ts +994 -0
  218. package/dist/bin/cli.js +135 -0
  219. package/dist/blueprint-manifest-CPQAL76N.cjs +504 -0
  220. package/dist/blueprint-manifest-FIMGDHSH.js +504 -0
  221. package/dist/blueprint-manifest.d-CU4v09fj.d.cts +3327 -0
  222. package/dist/blueprint-manifest.d-CU4v09fj.d.ts +3327 -0
  223. package/dist/chunk-3RG5ZIWI.js +10 -0
  224. package/dist/chunk-OBGZSXTJ.cjs +10 -0
  225. package/dist/chunk-UJTFRZMS.js +65 -0
  226. package/dist/chunk-YLLKMXS3.cjs +65 -0
  227. package/dist/consent-NHDCDJMK.js +84 -0
  228. package/dist/consent-R5GU3WCK.cjs +84 -0
  229. package/dist/consent.d-BETWwU_2.d.cts +266 -0
  230. package/dist/consent.d-BETWwU_2.d.ts +266 -0
  231. package/dist/customer-portal-6AV2W43T.cjs +2252 -0
  232. package/dist/customer-portal-EY57GJYV.js +2252 -0
  233. package/dist/customer-portal.d-Co_I6psR.d.cts +15255 -0
  234. package/dist/customer-portal.d-Co_I6psR.d.ts +15255 -0
  235. package/dist/data-management-ILQUYNTN.cjs +240 -0
  236. package/dist/data-management-QMXOLOEG.js +240 -0
  237. package/dist/data-management.d-CkR2E_Pm.d.cts +548 -0
  238. package/dist/data-management.d-CkR2E_Pm.d.ts +548 -0
  239. package/dist/deduplication-IVXANO7S.cjs +42 -0
  240. package/dist/deduplication-WN45DVK3.js +42 -0
  241. package/dist/deduplication.d-BlHnjhXk.d.cts +114 -0
  242. package/dist/deduplication.d-BlHnjhXk.d.ts +114 -0
  243. package/dist/design-ONRLY6XI.cjs +219 -0
  244. package/dist/design-UHMRO3PG.js +219 -0
  245. package/dist/design.d-JsNY_cGh.d.cts +834 -0
  246. package/dist/design.d-JsNY_cGh.d.ts +834 -0
  247. package/dist/discussion-4CZIG3ZM.cjs +134 -0
  248. package/dist/discussion-VWMWL2AF.js +134 -0
  249. package/dist/discussion.d-CxxaYKTf.d.cts +580 -0
  250. package/dist/discussion.d-CxxaYKTf.d.ts +580 -0
  251. package/dist/document-CN3JNXFF.js +78 -0
  252. package/dist/document-PCKNZA4K.cjs +78 -0
  253. package/dist/document.d-CZ_FGhEn.d.cts +649 -0
  254. package/dist/document.d-CZ_FGhEn.d.ts +649 -0
  255. package/dist/email-settings-ANURQMKZ.js +533 -0
  256. package/dist/email-settings-YE2XB2ZU.cjs +533 -0
  257. package/dist/email-settings.d-3eXYEyRr.d.cts +2278 -0
  258. package/dist/email-settings.d-3eXYEyRr.d.ts +2278 -0
  259. package/dist/email-template-4QI4YS4J.js +122 -0
  260. package/dist/email-template-BUJBC6HH.cjs +122 -0
  261. package/dist/email-template.d-C2L0dKqB.d.cts +1175 -0
  262. package/dist/email-template.d-C2L0dKqB.d.ts +1175 -0
  263. package/dist/entity-BCFE3UJT.cjs +1600 -0
  264. package/dist/entity-VEXNQC4Y.js +1600 -0
  265. package/dist/entity-mapping-PHRLSYP7.cjs +215 -0
  266. package/dist/entity-mapping-QK7MGNAW.js +215 -0
  267. package/dist/entity-mapping.d-B3Vyepok.d.cts +1093 -0
  268. package/dist/entity-mapping.d-B3Vyepok.d.ts +1093 -0
  269. package/dist/entity.d-DmER_7q5.d.cts +16018 -0
  270. package/dist/entity.d-DmER_7q5.d.ts +16018 -0
  271. package/dist/environments-266S44UM.cjs +71 -0
  272. package/dist/environments-AV7W6SLT.js +71 -0
  273. package/dist/environments.d-CpILpSNF.d.cts +254 -0
  274. package/dist/environments.d-CpILpSNF.d.ts +254 -0
  275. package/dist/erp-integration-5WNBCGWS.cjs +586 -0
  276. package/dist/erp-integration-EMI5WIWA.js +586 -0
  277. package/dist/erp-integration.d-DmxUZOUQ.d.cts +4120 -0
  278. package/dist/erp-integration.d-DmxUZOUQ.d.ts +4120 -0
  279. package/dist/event-catalog-DBWYKQ6J.cjs +130 -0
  280. package/dist/event-catalog-KKMXV5LB.js +130 -0
  281. package/dist/event-catalog.d-B2tq20gn.d.cts +1512 -0
  282. package/dist/event-catalog.d-B2tq20gn.d.ts +1512 -0
  283. package/dist/file-3ZLMS6TL.js +573 -0
  284. package/dist/file-Q66N5XMG.cjs +573 -0
  285. package/dist/file.d-Bi0EZkNu.d.cts +2993 -0
  286. package/dist/file.d-Bi0EZkNu.d.ts +2993 -0
  287. package/dist/iban-HSXVSIFW.cjs +43 -0
  288. package/dist/iban-Q27INTOC.js +43 -0
  289. package/dist/iban.d-DP7hl0Qt.d.cts +71 -0
  290. package/dist/iban.d-DP7hl0Qt.d.ts +71 -0
  291. package/dist/index.cjs +563 -0
  292. package/dist/index.d.cts +119 -0
  293. package/dist/index.d.ts +119 -0
  294. package/dist/index.js +563 -0
  295. package/dist/journey-DGKXVWZQ.js +270 -0
  296. package/dist/journey-T2Y72EBS.cjs +270 -0
  297. package/dist/journey.d-DxL16X6N.d.cts +1794 -0
  298. package/dist/journey.d-DxL16X6N.d.ts +1794 -0
  299. package/dist/kanban-A4B6RCJ2.cjs +164 -0
  300. package/dist/kanban-PP6WJVT2.js +164 -0
  301. package/dist/kanban.d-DDrBwr9h.d.cts +631 -0
  302. package/dist/kanban.d-DDrBwr9h.d.ts +631 -0
  303. package/dist/message-D6JY4GJH.cjs +673 -0
  304. package/dist/message-HFX2DDCV.js +673 -0
  305. package/dist/message.d-BeBH6vof.d.cts +3580 -0
  306. package/dist/message.d-BeBH6vof.d.ts +3580 -0
  307. package/dist/metering-63MJFCS2.cjs +399 -0
  308. package/dist/metering-F63PNFCZ.js +399 -0
  309. package/dist/metering.d-D5VR4tVa.d.cts +1842 -0
  310. package/dist/metering.d-D5VR4tVa.d.ts +1842 -0
  311. package/dist/notes-FTL5H4JE.cjs +219 -0
  312. package/dist/notes-GMWTQCMB.js +219 -0
  313. package/dist/notes.d-DZYeVo0I.d.cts +1047 -0
  314. package/dist/notes.d-DZYeVo0I.d.ts +1047 -0
  315. package/dist/notification-WXFSOORN.cjs +237 -0
  316. package/dist/notification-XHG3TIBW.js +237 -0
  317. package/dist/notification.d-BJwdFZnG.d.cts +1148 -0
  318. package/dist/notification.d-BJwdFZnG.d.ts +1148 -0
  319. package/dist/organization-CPXTUDJO.js +118 -0
  320. package/dist/organization-XIFV7MWP.cjs +118 -0
  321. package/dist/organization.d-DfUcuwKM.d.cts +629 -0
  322. package/dist/organization.d-DfUcuwKM.d.ts +629 -0
  323. package/dist/partner-directory-4WCHPJRO.js +282 -0
  324. package/dist/partner-directory-FKWPPO7F.cjs +282 -0
  325. package/dist/partner-directory.d-BRRDHFcz.d.cts +1511 -0
  326. package/dist/partner-directory.d-BRRDHFcz.d.ts +1511 -0
  327. package/dist/permissions-5E36GPG3.js +178 -0
  328. package/dist/permissions-PBTK5CCD.cjs +178 -0
  329. package/dist/permissions.d-CL7SwMFy.d.cts +1253 -0
  330. package/dist/permissions.d-CL7SwMFy.d.ts +1253 -0
  331. package/dist/pricing-FDWEBIQU.js +439 -0
  332. package/dist/pricing-FZQKL4DW.cjs +439 -0
  333. package/dist/pricing-tier-34O624R4.js +36 -0
  334. package/dist/pricing-tier-F4HE6WIM.cjs +36 -0
  335. package/dist/pricing-tier.d-VuH-NtlR.d.cts +82 -0
  336. package/dist/pricing-tier.d-VuH-NtlR.d.ts +82 -0
  337. package/dist/pricing.d-Dd1CaSX_.d.cts +12201 -0
  338. package/dist/pricing.d-Dd1CaSX_.d.ts +12201 -0
  339. package/dist/purpose-47HJIG2Q.cjs +180 -0
  340. package/dist/purpose-MX33NU5H.js +180 -0
  341. package/dist/purpose.d-D8YCSqt9.d.cts +373 -0
  342. package/dist/purpose.d-D8YCSqt9.d.ts +373 -0
  343. package/dist/sandbox-7QNLGFN2.cjs +100 -0
  344. package/dist/sandbox-TZCXHBJN.js +100 -0
  345. package/dist/sandbox.d-D1NgPMEc.d.cts +466 -0
  346. package/dist/sandbox.d-D1NgPMEc.d.ts +466 -0
  347. package/dist/submission-6LSPBI27.js +55 -0
  348. package/dist/submission-DBQNDJ4B.cjs +55 -0
  349. package/dist/submission.d-e9MPrbY1.d.cts +470 -0
  350. package/dist/submission.d-e9MPrbY1.d.ts +470 -0
  351. package/dist/targeting-HZRCLNIF.cjs +275 -0
  352. package/dist/targeting-MTQ6JBCY.js +275 -0
  353. package/dist/targeting.d-1GW3nh-y.d.cts +2058 -0
  354. package/dist/targeting.d-1GW3nh-y.d.ts +2058 -0
  355. package/dist/template-variables-S6IXK7SF.js +159 -0
  356. package/dist/template-variables-VPNIMC7L.cjs +159 -0
  357. package/dist/template-variables.d-CqqGe3sd.d.cts +1315 -0
  358. package/dist/template-variables.d-CqqGe3sd.d.ts +1315 -0
  359. package/dist/types-C5cGIwtq.d.cts +28 -0
  360. package/dist/types-C5cGIwtq.d.ts +28 -0
  361. package/dist/user-BHH4DAA5.cjs +488 -0
  362. package/dist/user-KBXFVRPI.js +488 -0
  363. package/dist/user.d-CWBgUia2.d.cts +2199 -0
  364. package/dist/user.d-CWBgUia2.d.ts +2199 -0
  365. package/dist/validation-rules-4V7KAWGW.cjs +120 -0
  366. package/dist/validation-rules-UGQY4ASY.js +120 -0
  367. package/dist/validation-rules.d-CMSvveua.d.cts +808 -0
  368. package/dist/validation-rules.d-CMSvveua.d.ts +808 -0
  369. package/dist/webhooks-JR475VD4.js +252 -0
  370. package/dist/webhooks-X64U3KCB.cjs +252 -0
  371. package/dist/webhooks.d-Bzl-u_Zs.d.cts +1201 -0
  372. package/dist/webhooks.d-Bzl-u_Zs.d.ts +1201 -0
  373. package/dist/workflow-7ANPQZDP.cjs +402 -0
  374. package/dist/workflow-DWSAHA5Q.js +402 -0
  375. package/dist/workflow-definition-2M3JBCUI.cjs +342 -0
  376. package/dist/workflow-definition-WLPGEU55.js +342 -0
  377. package/dist/workflow-definition.d-BKmIy2Qp.d.cts +2030 -0
  378. package/dist/workflow-definition.d-BKmIy2Qp.d.ts +2030 -0
  379. package/dist/workflow.d-DElz0XoQ.d.cts +3017 -0
  380. package/dist/workflow.d-DElz0XoQ.d.ts +3017 -0
  381. package/package.json +289 -0
@@ -0,0 +1,2030 @@
1
+ import { OpenAPIClient, Parameters, UnknownParamsObject, AxiosRequestConfig, OperationResponse } from 'openapi-client-axios';
2
+
3
+ /* eslint-disable */
4
+ /* Auto-copied from workflow-definition-client */
5
+ /* eslint-disable */
6
+
7
+
8
+
9
+ declare namespace Components {
10
+ namespace Schemas {
11
+ export type ActionSchedule = ImmediateSchedule | DelayedSchedule | RelativeSchedule;
12
+ /**
13
+ * Configuration for AI Agent to run
14
+ */
15
+ export interface AgentConfig {
16
+ [name: string]: any;
17
+ /**
18
+ * Id of the configured AI Agent to run
19
+ */
20
+ agent_id: string;
21
+ }
22
+ export interface AiAgentTask {
23
+ id: string;
24
+ name: string;
25
+ description?: /* Longer information regarding Task */ StepDescription;
26
+ journey?: StepJourney;
27
+ /**
28
+ * example:
29
+ * 2021-04-27T12:00:00.000Z
30
+ */
31
+ due_date?: string;
32
+ due_date_config?: /* Set due date for the task based on a dynamic condition */ DueDateConfig;
33
+ /**
34
+ * requirements that need to be fulfilled in order to enable the task while flow instances are running
35
+ */
36
+ requirements?: /* describe the requirement for a task to be enabled */ EnableRequirement[];
37
+ assigned_to?: (string | /* Represents a variable assignment with its expression and optional resolved value. Used for dynamic user assignments that get resolved during workflow execution. */ VariableAssignment)[];
38
+ ecp?: /* Details regarding ECP for the workflow step */ ECPDetails;
39
+ installer?: /* Details regarding ECP for the workflow step */ ECPDetails;
40
+ /**
41
+ * Taxonomy ids that are associated with this workflow and used for filtering
42
+ */
43
+ taxonomies?: string[];
44
+ phase_id?: string;
45
+ task_type: TaskType;
46
+ agent_config?: /* Configuration for AI Agent to run */ AgentConfig;
47
+ }
48
+ /**
49
+ * Configuration for automation execution to run
50
+ */
51
+ export interface AutomationConfig {
52
+ /**
53
+ * Id of the configured automation to run
54
+ */
55
+ flow_id?: string;
56
+ /**
57
+ * Transient field. The full automation action configuration following the automation API action schema. Processed by the backend during create/update and stripped before storage. When present without a flow_id, a new automation flow is created. When present with a flow_id, the existing automation flow is updated.
58
+ *
59
+ */
60
+ action_config?: {
61
+ [name: string]: any;
62
+ /**
63
+ * The action type (e.g. send-email, trigger-workflow)
64
+ */
65
+ type: string;
66
+ /**
67
+ * Action-specific configuration
68
+ */
69
+ config?: {
70
+ [name: string]: any;
71
+ };
72
+ };
73
+ }
74
+ export interface AutomationTask {
75
+ id: string;
76
+ name: string;
77
+ description?: /* Longer information regarding Task */ StepDescription;
78
+ journey?: StepJourney;
79
+ /**
80
+ * example:
81
+ * 2021-04-27T12:00:00.000Z
82
+ */
83
+ due_date?: string;
84
+ due_date_config?: /* Set due date for the task based on a dynamic condition */ DueDateConfig;
85
+ /**
86
+ * requirements that need to be fulfilled in order to enable the task while flow instances are running
87
+ */
88
+ requirements?: /* describe the requirement for a task to be enabled */ EnableRequirement[];
89
+ assigned_to?: (string | /* Represents a variable assignment with its expression and optional resolved value. Used for dynamic user assignments that get resolved during workflow execution. */ VariableAssignment)[];
90
+ ecp?: /* Details regarding ECP for the workflow step */ ECPDetails;
91
+ installer?: /* Details regarding ECP for the workflow step */ ECPDetails;
92
+ /**
93
+ * Taxonomy ids that are associated with this workflow and used for filtering
94
+ */
95
+ taxonomies?: string[];
96
+ phase_id?: string;
97
+ task_type: TaskType;
98
+ automation_config: /* Configuration for automation execution to run */ AutomationConfig;
99
+ trigger_mode?: TriggerMode;
100
+ schedule?: ActionSchedule;
101
+ /**
102
+ * Indicates whether this task was created automatically by journeys or manually by an user
103
+ */
104
+ created_automatically?: boolean;
105
+ }
106
+ export interface AutomationTrigger {
107
+ id?: string;
108
+ type: "automation";
109
+ /**
110
+ * Id of the automation config that triggers this workflow
111
+ */
112
+ automation_id?: string;
113
+ /**
114
+ * Transient field. Trigger configurations for creating or updating the trigger automation flow. Each item follows the automation API trigger schema. Processed by the backend during create/update and stripped before storage.
115
+ *
116
+ */
117
+ trigger_config?: {
118
+ [name: string]: any;
119
+ /**
120
+ * The trigger type (e.g. entity_operation, activity)
121
+ */
122
+ type: string;
123
+ /**
124
+ * Trigger-specific configuration
125
+ */
126
+ configuration?: {
127
+ [name: string]: any;
128
+ };
129
+ }[];
130
+ }
131
+ export interface ChangeReasonStatusReq {
132
+ status: ClosingReasonsStatus;
133
+ }
134
+ /**
135
+ * One Closing reason for a workflow
136
+ */
137
+ export interface ClosingReason {
138
+ id?: string;
139
+ title: string;
140
+ status: ClosingReasonsStatus;
141
+ lastUpdateTime?: string;
142
+ creationTime?: string;
143
+ }
144
+ export interface ClosingReasonId {
145
+ /**
146
+ * example:
147
+ * x739cew
148
+ */
149
+ id: string;
150
+ }
151
+ /**
152
+ * Closing reason could be not found
153
+ */
154
+ export interface ClosingReasonNotFoundResp {
155
+ message?: string;
156
+ }
157
+ export interface ClosingReasons {
158
+ reasons: /* One Closing reason for a workflow */ ClosingReason[];
159
+ }
160
+ export interface ClosingReasonsIds {
161
+ reasons: ClosingReasonId[];
162
+ }
163
+ export type ClosingReasonsStatus = "ACTIVE" | "INACTIVE";
164
+ export interface Condition {
165
+ id: string;
166
+ /**
167
+ * The name of the branch
168
+ * example:
169
+ * Branch 1
170
+ */
171
+ branch_name: string;
172
+ logical_operator: "AND" | "OR";
173
+ statements: Statement[];
174
+ }
175
+ export interface CreateFlowTemplate {
176
+ id?: string;
177
+ org_id?: string;
178
+ name: string;
179
+ description?: string;
180
+ trigger?: /**
181
+ * example:
182
+ * {
183
+ * "type": "automation",
184
+ * "automation_id": "g92j2-sg9ug92hjt1gh-9s9gajgs-a979gg"
185
+ * }
186
+ */
187
+ Trigger;
188
+ /**
189
+ * Whether the workflow is enabled or not
190
+ */
191
+ enabled?: boolean;
192
+ version?: /**
193
+ * Version of the workflow schema.
194
+ *
195
+ * - `v1` – *Deprecated*. The initial version of workflows with limited structure and automation capabilities.
196
+ * - `v2` – Linear workflows. Supports sequential task execution with basic automation triggers.
197
+ * - `v3` – Advanced workflows. Adds support for branching logic (conditions), parallel paths, and enhanced automation features such as dynamic triggers and flow control.
198
+ *
199
+ * example:
200
+ * 2
201
+ */
202
+ Version;
203
+ /**
204
+ * ISO String Date & Time
205
+ * example:
206
+ * 2021-04-27T12:01:13.000Z
207
+ */
208
+ created_at?: string;
209
+ /**
210
+ * ISO String Date & Time
211
+ * example:
212
+ * 2021-04-27T12:01:13.000Z
213
+ */
214
+ updated_at?: string;
215
+ /**
216
+ * example:
217
+ * 2021-04-27T12:00:00.000Z
218
+ */
219
+ due_date?: string;
220
+ due_date_config?: /* Set due date for the task based on a dynamic condition */ DueDateConfig;
221
+ assigned_to?: (string | /* Represents a variable assignment with its expression and optional resolved value. Used for dynamic user assignments that get resolved during workflow execution. */ VariableAssignment)[];
222
+ /**
223
+ * Indicates whether this workflow is available for End Customer Portal or not. By default it's not.
224
+ */
225
+ available_in_ecp?: boolean;
226
+ /**
227
+ * Additional trigger configurations that can also start this flow. Useful for flows that should be startable via multiple methods (e.g., both automation AND manual).
228
+ */
229
+ additional_triggers?: /**
230
+ * example:
231
+ * {
232
+ * "type": "automation",
233
+ * "automation_id": "g92j2-sg9ug92hjt1gh-9s9gajgs-a979gg"
234
+ * }
235
+ */
236
+ Trigger[];
237
+ phases?: Phase[];
238
+ tasks: Task[];
239
+ edges: Edge[];
240
+ closing_reasons?: /* One Closing reason for a workflow */ ClosingReason[];
241
+ entity_sync?: /**
242
+ * example:
243
+ * {
244
+ * "trigger": {
245
+ * "event": "FlowStarted"
246
+ * },
247
+ * "target": {
248
+ * "entitySchema": "opportunity",
249
+ * "entityAttribute": "title"
250
+ * },
251
+ * "value": {
252
+ * "source": "workflow_name"
253
+ * }
254
+ * }
255
+ */
256
+ EntitySync[];
257
+ /**
258
+ * Taxonomy ids that are associated with this workflow and used for filtering
259
+ */
260
+ taxonomies?: string[];
261
+ /**
262
+ * Whether only a single closing reason can be selected
263
+ */
264
+ singleClosingReasonSelection?: boolean;
265
+ }
266
+ export interface DecisionTask {
267
+ id: string;
268
+ name: string;
269
+ description?: /* Longer information regarding Task */ StepDescription;
270
+ journey?: StepJourney;
271
+ /**
272
+ * example:
273
+ * 2021-04-27T12:00:00.000Z
274
+ */
275
+ due_date?: string;
276
+ due_date_config?: /* Set due date for the task based on a dynamic condition */ DueDateConfig;
277
+ /**
278
+ * requirements that need to be fulfilled in order to enable the task while flow instances are running
279
+ */
280
+ requirements?: /* describe the requirement for a task to be enabled */ EnableRequirement[];
281
+ assigned_to?: (string | /* Represents a variable assignment with its expression and optional resolved value. Used for dynamic user assignments that get resolved during workflow execution. */ VariableAssignment)[];
282
+ ecp?: /* Details regarding ECP for the workflow step */ ECPDetails;
283
+ installer?: /* Details regarding ECP for the workflow step */ ECPDetails;
284
+ /**
285
+ * Taxonomy ids that are associated with this workflow and used for filtering
286
+ */
287
+ taxonomies?: string[];
288
+ phase_id?: string;
289
+ task_type: TaskType;
290
+ trigger_mode: TriggerMode;
291
+ conditions: Condition[];
292
+ schedule?: DelayedSchedule | RelativeSchedule;
293
+ loop_config?: {
294
+ /**
295
+ * The id of the branch that will be looped
296
+ */
297
+ loop_branch_id: string;
298
+ /**
299
+ * The id of the branch that will be used to exit the loop
300
+ */
301
+ exit_branch_id: string;
302
+ /**
303
+ * Maximum number of iterations for the loop branch
304
+ */
305
+ max_iterations: number;
306
+ };
307
+ }
308
+ /**
309
+ * Definition could be not found
310
+ */
311
+ export interface DefinitionNotFoundResp {
312
+ message?: string;
313
+ }
314
+ export interface DelayedSchedule {
315
+ mode: "delayed";
316
+ duration: number;
317
+ unit: TimeUnit;
318
+ }
319
+ /**
320
+ * Set due date for the task based on a dynamic condition
321
+ */
322
+ export interface DueDateConfig {
323
+ duration: number;
324
+ unit: TimeUnit;
325
+ type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED";
326
+ task_id?: string;
327
+ phase_id?: string;
328
+ }
329
+ /**
330
+ * set a Duedate for a step then a specific
331
+ */
332
+ export interface DynamicDueDate {
333
+ numberOfUnits: number;
334
+ timePeriod: TimeUnit;
335
+ actionTypeCondition: "WORKFLOW_STARTED" | "STEP_CLOSED" | "PHASE_FINISHED";
336
+ stepId?: string;
337
+ phaseId?: string;
338
+ }
339
+ /**
340
+ * Details regarding ECP for the workflow step
341
+ */
342
+ export interface ECPDetails {
343
+ enabled?: boolean;
344
+ label?: string;
345
+ description?: string;
346
+ journey?: StepJourney;
347
+ }
348
+ export interface Edge {
349
+ id: string;
350
+ from_id: string;
351
+ to_id: string;
352
+ condition_id?: string;
353
+ /**
354
+ * 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.
355
+ */
356
+ none_met?: boolean;
357
+ }
358
+ /**
359
+ * describe the requirement for a task to be enabled
360
+ */
361
+ export interface EnableRequirement {
362
+ /**
363
+ * The id of the task that it points to
364
+ */
365
+ task_id?: string;
366
+ /**
367
+ * The id of the phase that it points to
368
+ */
369
+ phase_id?: string;
370
+ when: "TASK_FINISHED" | "PHASE_FINISHED";
371
+ }
372
+ /**
373
+ * example:
374
+ * {
375
+ * "trigger": {
376
+ * "event": "FlowStarted"
377
+ * },
378
+ * "target": {
379
+ * "entitySchema": "opportunity",
380
+ * "entityAttribute": "title"
381
+ * },
382
+ * "value": {
383
+ * "source": "workflow_name"
384
+ * }
385
+ * }
386
+ */
387
+ export interface EntitySync {
388
+ /**
389
+ * Trigger configuration that determines when entity sync occurs.
390
+ * Contains the event type and optional filter to target specific tasks/phases.
391
+ *
392
+ */
393
+ trigger: {
394
+ /**
395
+ * Event or condition that triggers the entity sync.
396
+ * Direct triggers match EventBridge event names (PascalCase).
397
+ * Status triggers are deduced from event + entity status combination.
398
+ *
399
+ */
400
+ event: "FlowStarted" | "FlowCompleted" | "FlowCancelled" | "FlowReopened" | "FlowDeleted" | "FlowAssigned" | "FlowDueDateChanged" | "FlowContextsChanged" | "TaskUpdated" | "CurrTaskChanged" | "TaskCompleted" | "TaskSkipped" | "TaskMarkedInProgress" | "TaskMarkedOnHold" | "PhaseUpdated" | "PhaseCompleted" | "PhaseSkipped" | "PhaseMarkedInProgress";
401
+ /**
402
+ * Optional filter to target specific tasks or phases.
403
+ * Specify either task_template_id OR phase_template_id (mutually exclusive).
404
+ * If omitted, trigger applies to all tasks/phases.
405
+ *
406
+ */
407
+ filter?: {
408
+ /**
409
+ * Target a specific task by its template ID (stable across executions)
410
+ */
411
+ task_template_id?: string;
412
+ /**
413
+ * Target a specific phase by its template ID (stable across executions)
414
+ */
415
+ phase_template_id?: string;
416
+ };
417
+ };
418
+ value: {
419
+ source: "workflow_name" | "workflow_status" | "workflow_assigned_to" | "task_name" | "task_status" | "task_assigned_to" | "phase_name" | "phase_status" | "phase_assigned_to" | "custom_value";
420
+ value?: string;
421
+ };
422
+ target: {
423
+ /**
424
+ * example:
425
+ * opportunity
426
+ */
427
+ entitySchema: string;
428
+ /**
429
+ * example:
430
+ * title
431
+ */
432
+ entityAttribute: string;
433
+ };
434
+ }
435
+ export interface ErrorResp {
436
+ message?: string;
437
+ }
438
+ export interface EvaluationSource {
439
+ /**
440
+ * The id of the action or trigger
441
+ */
442
+ id?: string;
443
+ origin?: "trigger" | "action";
444
+ origin_type?: "entity" | "workflow" | "journey_block";
445
+ schema?: string;
446
+ attribute?: string;
447
+ 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";
448
+ attribute_repeatable?: boolean;
449
+ attribute_operation?: "all" | "updated" | "added" | "deleted";
450
+ /**
451
+ * For complex attribute types, specifies which sub-field to extract (e.g., 'address', 'name', 'email_type')
452
+ */
453
+ attribute_sub_field?: string;
454
+ }
455
+ export interface FlowTemplate {
456
+ id?: string;
457
+ org_id?: string;
458
+ name: string;
459
+ description?: string;
460
+ trigger?: /**
461
+ * example:
462
+ * {
463
+ * "type": "automation",
464
+ * "automation_id": "g92j2-sg9ug92hjt1gh-9s9gajgs-a979gg"
465
+ * }
466
+ */
467
+ Trigger;
468
+ /**
469
+ * Whether the workflow is enabled or not
470
+ */
471
+ enabled?: boolean;
472
+ version?: /**
473
+ * Version of the workflow schema.
474
+ *
475
+ * - `v1` – *Deprecated*. The initial version of workflows with limited structure and automation capabilities.
476
+ * - `v2` – Linear workflows. Supports sequential task execution with basic automation triggers.
477
+ * - `v3` – Advanced workflows. Adds support for branching logic (conditions), parallel paths, and enhanced automation features such as dynamic triggers and flow control.
478
+ *
479
+ * example:
480
+ * 2
481
+ */
482
+ Version;
483
+ /**
484
+ * ISO String Date & Time
485
+ * example:
486
+ * 2021-04-27T12:01:13.000Z
487
+ */
488
+ created_at?: string;
489
+ /**
490
+ * ISO String Date & Time
491
+ * example:
492
+ * 2021-04-27T12:01:13.000Z
493
+ */
494
+ updated_at?: string;
495
+ /**
496
+ * example:
497
+ * 2021-04-27T12:00:00.000Z
498
+ */
499
+ due_date?: string;
500
+ due_date_config?: /* Set due date for the task based on a dynamic condition */ DueDateConfig;
501
+ assigned_to?: (string | /* Represents a variable assignment with its expression and optional resolved value. Used for dynamic user assignments that get resolved during workflow execution. */ VariableAssignment)[];
502
+ /**
503
+ * Indicates whether this workflow is available for End Customer Portal or not. By default it's not.
504
+ */
505
+ available_in_ecp?: boolean;
506
+ /**
507
+ * Additional trigger configurations that can also start this flow. Useful for flows that should be startable via multiple methods (e.g., both automation AND manual).
508
+ */
509
+ additional_triggers?: /**
510
+ * example:
511
+ * {
512
+ * "type": "automation",
513
+ * "automation_id": "g92j2-sg9ug92hjt1gh-9s9gajgs-a979gg"
514
+ * }
515
+ */
516
+ Trigger[];
517
+ phases?: Phase[];
518
+ tasks: Task[];
519
+ edges: Edge[];
520
+ closing_reasons?: /* One Closing reason for a workflow */ ClosingReason[];
521
+ entity_sync?: /**
522
+ * example:
523
+ * {
524
+ * "trigger": {
525
+ * "event": "FlowStarted"
526
+ * },
527
+ * "target": {
528
+ * "entitySchema": "opportunity",
529
+ * "entityAttribute": "title"
530
+ * },
531
+ * "value": {
532
+ * "source": "workflow_name"
533
+ * }
534
+ * }
535
+ */
536
+ EntitySync[];
537
+ /**
538
+ * Taxonomy ids that are associated with this workflow and used for filtering
539
+ */
540
+ taxonomies?: string[];
541
+ /**
542
+ * Whether only a single closing reason can be selected
543
+ */
544
+ singleClosingReasonSelection?: boolean;
545
+ }
546
+ export interface FlowTemplateBase {
547
+ id?: string;
548
+ org_id?: string;
549
+ name: string;
550
+ description?: string;
551
+ trigger?: /**
552
+ * example:
553
+ * {
554
+ * "type": "automation",
555
+ * "automation_id": "g92j2-sg9ug92hjt1gh-9s9gajgs-a979gg"
556
+ * }
557
+ */
558
+ Trigger;
559
+ /**
560
+ * Whether the workflow is enabled or not
561
+ */
562
+ enabled?: boolean;
563
+ version?: /**
564
+ * Version of the workflow schema.
565
+ *
566
+ * - `v1` – *Deprecated*. The initial version of workflows with limited structure and automation capabilities.
567
+ * - `v2` – Linear workflows. Supports sequential task execution with basic automation triggers.
568
+ * - `v3` – Advanced workflows. Adds support for branching logic (conditions), parallel paths, and enhanced automation features such as dynamic triggers and flow control.
569
+ *
570
+ * example:
571
+ * 2
572
+ */
573
+ Version;
574
+ /**
575
+ * ISO String Date & Time
576
+ * example:
577
+ * 2021-04-27T12:01:13.000Z
578
+ */
579
+ created_at?: string;
580
+ /**
581
+ * ISO String Date & Time
582
+ * example:
583
+ * 2021-04-27T12:01:13.000Z
584
+ */
585
+ updated_at?: string;
586
+ /**
587
+ * example:
588
+ * 2021-04-27T12:00:00.000Z
589
+ */
590
+ due_date?: string;
591
+ due_date_config?: /* Set due date for the task based on a dynamic condition */ DueDateConfig;
592
+ assigned_to?: (string | /* Represents a variable assignment with its expression and optional resolved value. Used for dynamic user assignments that get resolved during workflow execution. */ VariableAssignment)[];
593
+ /**
594
+ * Indicates whether this workflow is available for End Customer Portal or not. By default it's not.
595
+ */
596
+ available_in_ecp?: boolean;
597
+ /**
598
+ * Additional trigger configurations that can also start this flow. Useful for flows that should be startable via multiple methods (e.g., both automation AND manual).
599
+ */
600
+ additional_triggers?: /**
601
+ * example:
602
+ * {
603
+ * "type": "automation",
604
+ * "automation_id": "g92j2-sg9ug92hjt1gh-9s9gajgs-a979gg"
605
+ * }
606
+ */
607
+ Trigger[];
608
+ phases?: Phase[];
609
+ tasks: Task[];
610
+ edges: Edge[];
611
+ closing_reasons?: /* One Closing reason for a workflow */ ClosingReason[];
612
+ entity_sync?: /**
613
+ * example:
614
+ * {
615
+ * "trigger": {
616
+ * "event": "FlowStarted"
617
+ * },
618
+ * "target": {
619
+ * "entitySchema": "opportunity",
620
+ * "entityAttribute": "title"
621
+ * },
622
+ * "value": {
623
+ * "source": "workflow_name"
624
+ * }
625
+ * }
626
+ */
627
+ EntitySync[];
628
+ /**
629
+ * Taxonomy ids that are associated with this workflow and used for filtering
630
+ */
631
+ taxonomies?: string[];
632
+ /**
633
+ * Whether only a single closing reason can be selected
634
+ */
635
+ singleClosingReasonSelection?: boolean;
636
+ }
637
+ export interface FlowTemplateExport {
638
+ id?: string;
639
+ org_id?: string;
640
+ name: string;
641
+ description?: string;
642
+ trigger?: /**
643
+ * example:
644
+ * {
645
+ * "type": "automation",
646
+ * "automation_id": "g92j2-sg9ug92hjt1gh-9s9gajgs-a979gg"
647
+ * }
648
+ */
649
+ Trigger;
650
+ /**
651
+ * Whether the workflow is enabled or not
652
+ */
653
+ enabled?: boolean;
654
+ version?: /**
655
+ * Version of the workflow schema.
656
+ *
657
+ * - `v1` – *Deprecated*. The initial version of workflows with limited structure and automation capabilities.
658
+ * - `v2` – Linear workflows. Supports sequential task execution with basic automation triggers.
659
+ * - `v3` – Advanced workflows. Adds support for branching logic (conditions), parallel paths, and enhanced automation features such as dynamic triggers and flow control.
660
+ *
661
+ * example:
662
+ * 2
663
+ */
664
+ Version;
665
+ /**
666
+ * ISO String Date & Time
667
+ * example:
668
+ * 2021-04-27T12:01:13.000Z
669
+ */
670
+ created_at?: string;
671
+ /**
672
+ * ISO String Date & Time
673
+ * example:
674
+ * 2021-04-27T12:01:13.000Z
675
+ */
676
+ updated_at?: string;
677
+ /**
678
+ * example:
679
+ * 2021-04-27T12:00:00.000Z
680
+ */
681
+ due_date?: string;
682
+ due_date_config?: /* Set due date for the task based on a dynamic condition */ DueDateConfig;
683
+ assigned_to?: (string | /* Represents a variable assignment with its expression and optional resolved value. Used for dynamic user assignments that get resolved during workflow execution. */ VariableAssignment)[];
684
+ /**
685
+ * Indicates whether this workflow is available for End Customer Portal or not. By default it's not.
686
+ */
687
+ available_in_ecp?: boolean;
688
+ /**
689
+ * Additional trigger configurations that can also start this flow. Useful for flows that should be startable via multiple methods (e.g., both automation AND manual).
690
+ */
691
+ additional_triggers?: /**
692
+ * example:
693
+ * {
694
+ * "type": "automation",
695
+ * "automation_id": "g92j2-sg9ug92hjt1gh-9s9gajgs-a979gg"
696
+ * }
697
+ */
698
+ Trigger[];
699
+ phases?: Phase[];
700
+ tasks: Task[];
701
+ edges: Edge[];
702
+ closing_reasons?: /* One Closing reason for a workflow */ ClosingReason[];
703
+ entity_sync?: /**
704
+ * example:
705
+ * {
706
+ * "trigger": {
707
+ * "event": "FlowStarted"
708
+ * },
709
+ * "target": {
710
+ * "entitySchema": "opportunity",
711
+ * "entityAttribute": "title"
712
+ * },
713
+ * "value": {
714
+ * "source": "workflow_name"
715
+ * }
716
+ * }
717
+ */
718
+ EntitySync[];
719
+ /**
720
+ * Taxonomy ids that are associated with this workflow and used for filtering
721
+ */
722
+ taxonomies?: string[];
723
+ /**
724
+ * Whether only a single closing reason can be selected
725
+ */
726
+ singleClosingReasonSelection?: boolean;
727
+ /**
728
+ * Map of automation_id to full AutomationFlow object. Null values indicate automations that could not be resolved.
729
+ */
730
+ _resolved_automations?: {
731
+ [name: string]: {
732
+ [key: string]: any;
733
+ };
734
+ };
735
+ }
736
+ /**
737
+ * Short unique id (length 8) to identify the Flow Template.
738
+ * example:
739
+ * 7hj28akg
740
+ */
741
+ export type FlowTemplateId = string;
742
+ export interface FlowTemplateImportResult {
743
+ flow?: FlowTemplate;
744
+ /**
745
+ * Maps old IDs to new IDs for cross-referencing by callers (e.g. blueprint service)
746
+ */
747
+ _id_mappings?: {
748
+ flow_id?: {
749
+ old?: string;
750
+ new?: string;
751
+ };
752
+ /**
753
+ * Map of old_task_id to new_task_id
754
+ */
755
+ task_ids?: {
756
+ [name: string]: string;
757
+ };
758
+ /**
759
+ * Map of old_automation_id to new_automation_id
760
+ */
761
+ automation_ids?: {
762
+ [name: string]: string;
763
+ };
764
+ };
765
+ }
766
+ export interface FlowTemplatesList {
767
+ results: FlowTemplate[];
768
+ }
769
+ export interface ImmediateSchedule {
770
+ mode?: "immediate";
771
+ }
772
+ export type ItemType = "STEP" | "SECTION";
773
+ export interface JourneyAutomationTrigger {
774
+ id?: string;
775
+ type: "journey_automation";
776
+ /**
777
+ * Schema of the main entity where flow will be triggered. The entity will be picked from automation context.
778
+ */
779
+ entity_schema?: string;
780
+ }
781
+ export interface JourneySubmissionTrigger {
782
+ id?: string;
783
+ type: "journey_submission";
784
+ /**
785
+ * ID of the journey that will trigger this flow
786
+ */
787
+ journey_id: string;
788
+ /**
789
+ * Name of the journey that will trigger this flow
790
+ */
791
+ journey_name?: string;
792
+ automation_id?: string;
793
+ }
794
+ export interface ManualTask {
795
+ id: string;
796
+ name: string;
797
+ description?: /* Longer information regarding Task */ StepDescription;
798
+ journey?: StepJourney;
799
+ /**
800
+ * example:
801
+ * 2021-04-27T12:00:00.000Z
802
+ */
803
+ due_date?: string;
804
+ due_date_config?: /* Set due date for the task based on a dynamic condition */ DueDateConfig;
805
+ /**
806
+ * requirements that need to be fulfilled in order to enable the task while flow instances are running
807
+ */
808
+ requirements?: /* describe the requirement for a task to be enabled */ EnableRequirement[];
809
+ assigned_to?: (string | /* Represents a variable assignment with its expression and optional resolved value. Used for dynamic user assignments that get resolved during workflow execution. */ VariableAssignment)[];
810
+ ecp?: /* Details regarding ECP for the workflow step */ ECPDetails;
811
+ installer?: /* Details regarding ECP for the workflow step */ ECPDetails;
812
+ /**
813
+ * Taxonomy ids that are associated with this workflow and used for filtering
814
+ */
815
+ taxonomies?: string[];
816
+ phase_id?: string;
817
+ task_type: TaskType;
818
+ }
819
+ export interface ManualTrigger {
820
+ id?: string;
821
+ type: "manual";
822
+ entity_schema?: string;
823
+ }
824
+ export interface MaxAllowedLimit {
825
+ currentNoOfWorkflows?: number;
826
+ maxAllowed?: number;
827
+ }
828
+ 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";
829
+ export interface Phase {
830
+ id: string;
831
+ name: string;
832
+ /**
833
+ * example:
834
+ * 2021-04-27T12:00:00.000Z
835
+ */
836
+ due_date?: string;
837
+ due_date_config?: /* Set due date for the task based on a dynamic condition */ DueDateConfig;
838
+ assigned_to?: (string | /* Represents a variable assignment with its expression and optional resolved value. Used for dynamic user assignments that get resolved during workflow execution. */ VariableAssignment)[];
839
+ /**
840
+ * Taxonomy ids that are associated with this workflow and used for filtering
841
+ */
842
+ taxonomies?: string[];
843
+ }
844
+ export interface RelativeSchedule {
845
+ mode: "relative";
846
+ direction: "before" | "after";
847
+ duration: number;
848
+ unit: TimeUnit;
849
+ reference: {
850
+ /**
851
+ * The id of the entity / workflow / task, based on the origin of the schedule
852
+ */
853
+ id: string;
854
+ origin: "flow_started" | "task_completed" | "trigger_entity_attribute";
855
+ /**
856
+ * The schema of the entity
857
+ */
858
+ schema?: string;
859
+ /**
860
+ * An entity attribute that identifies a date / datetime
861
+ */
862
+ attribute?: string;
863
+ };
864
+ }
865
+ export interface SearchFlowTemplates {
866
+ name?: string;
867
+ definition_id?: string;
868
+ trigger_type?: "journey_submission" | "manual" | "automation";
869
+ enabled?: boolean;
870
+ from?: number;
871
+ size?: number;
872
+ sort_by?: "created_at" | "updated_at";
873
+ sort_order?: "asc" | "desc";
874
+ }
875
+ /**
876
+ * A group of Steps that define the progress of the Workflow
877
+ */
878
+ export interface Section {
879
+ id?: string;
880
+ name: string;
881
+ order: number;
882
+ type: ItemType;
883
+ /**
884
+ * example:
885
+ * 2021-04-27T12:00:00.000Z
886
+ */
887
+ dueDate?: string;
888
+ dynamicDueDate?: /* set a Duedate for a step then a specific */ DynamicDueDate;
889
+ assignedTo?: string[];
890
+ steps: /* Action that needs to be done in a Workflow */ Step[];
891
+ /**
892
+ * Taxonomy ids that are associated with this workflow and used for filtering
893
+ */
894
+ taxonomies?: string[];
895
+ }
896
+ export interface Statement {
897
+ id: string;
898
+ source: EvaluationSource;
899
+ operator: Operator;
900
+ values: string[];
901
+ }
902
+ /**
903
+ * Action that needs to be done in a Workflow
904
+ */
905
+ export interface Step {
906
+ id?: string;
907
+ name: string;
908
+ description?: /* Longer information regarding Task */ StepDescription;
909
+ executionType?: StepType;
910
+ automationConfig?: {
911
+ /**
912
+ * Id of the configured automation to run
913
+ */
914
+ flowId: string;
915
+ };
916
+ journey?: StepJourney;
917
+ order: number;
918
+ /**
919
+ * example:
920
+ * 2021-04-27T12:00:00.000Z
921
+ */
922
+ dueDate?: string;
923
+ dynamicDueDate?: /* set a Duedate for a step then a specific */ DynamicDueDate;
924
+ /**
925
+ * This field is deprecated. Please use assignedTo
926
+ */
927
+ userIds?: number[];
928
+ /**
929
+ * requirements that need to be fulfilled in order to enable the step execution
930
+ */
931
+ requirements?: /* describe the requirement for step enablement */ StepRequirement[];
932
+ assignedTo?: string[];
933
+ type: ItemType;
934
+ ecp?: /* Details regarding ECP for the workflow step */ ECPDetails;
935
+ installer?: /* Details regarding ECP for the workflow step */ ECPDetails;
936
+ /**
937
+ * Taxonomy ids that are associated with this workflow and used for filtering
938
+ */
939
+ taxonomies?: string[];
940
+ }
941
+ /**
942
+ * Longer information regarding Task
943
+ */
944
+ export interface StepDescription {
945
+ enabled?: boolean;
946
+ value?: string;
947
+ }
948
+ export interface StepJourney {
949
+ id?: string;
950
+ journeyId?: string;
951
+ name?: string;
952
+ /**
953
+ * If true, the task be auto completed when the journey is completed. By default it is true.
954
+ */
955
+ complete_task_automatically?: boolean;
956
+ }
957
+ /**
958
+ * describe the requirement for step enablement
959
+ */
960
+ export interface StepRequirement {
961
+ definitionId: string;
962
+ type: ItemType;
963
+ condition: "CLOSED";
964
+ }
965
+ export type StepType = "MANUAL" | "AUTOMATION";
966
+ export type Task = ManualTask | AutomationTask | DecisionTask | AiAgentTask;
967
+ export interface TaskBase {
968
+ id: string;
969
+ name: string;
970
+ description?: /* Longer information regarding Task */ StepDescription;
971
+ journey?: StepJourney;
972
+ /**
973
+ * example:
974
+ * 2021-04-27T12:00:00.000Z
975
+ */
976
+ due_date?: string;
977
+ due_date_config?: /* Set due date for the task based on a dynamic condition */ DueDateConfig;
978
+ /**
979
+ * requirements that need to be fulfilled in order to enable the task while flow instances are running
980
+ */
981
+ requirements?: /* describe the requirement for a task to be enabled */ EnableRequirement[];
982
+ assigned_to?: (string | /* Represents a variable assignment with its expression and optional resolved value. Used for dynamic user assignments that get resolved during workflow execution. */ VariableAssignment)[];
983
+ ecp?: /* Details regarding ECP for the workflow step */ ECPDetails;
984
+ installer?: /* Details regarding ECP for the workflow step */ ECPDetails;
985
+ /**
986
+ * Taxonomy ids that are associated with this workflow and used for filtering
987
+ */
988
+ taxonomies?: string[];
989
+ phase_id?: string;
990
+ task_type: TaskType;
991
+ }
992
+ export type TaskType = "MANUAL" | "AUTOMATION" | "DECISION" | "AI_AGENT";
993
+ export type TimeUnit = "minutes" | "hours" | "days" | "weeks" | "months";
994
+ /**
995
+ * example:
996
+ * {
997
+ * "type": "automation",
998
+ * "automation_id": "g92j2-sg9ug92hjt1gh-9s9gajgs-a979gg"
999
+ * }
1000
+ */
1001
+ export type Trigger = /**
1002
+ * example:
1003
+ * {
1004
+ * "type": "automation",
1005
+ * "automation_id": "g92j2-sg9ug92hjt1gh-9s9gajgs-a979gg"
1006
+ * }
1007
+ */
1008
+ ManualTrigger | AutomationTrigger | JourneySubmissionTrigger | JourneyAutomationTrigger;
1009
+ export type TriggerMode = "manual" | "automatic";
1010
+ export type TriggerType = "MANUAL" | "AUTOMATIC";
1011
+ export interface UpdateEntityAttributes {
1012
+ source: "workflow_status" | "current_section" | "current_step";
1013
+ target: {
1014
+ /**
1015
+ * example:
1016
+ * opportunity
1017
+ */
1018
+ entitySchema: string;
1019
+ /**
1020
+ * example:
1021
+ * my_status
1022
+ */
1023
+ entityAttribute: string;
1024
+ };
1025
+ }
1026
+ /**
1027
+ * Represents a variable assignment with its expression and optional resolved value. Used for dynamic user assignments that get resolved during workflow execution.
1028
+ */
1029
+ export interface VariableAssignment {
1030
+ /**
1031
+ * The variable expression, e.g., "{{entity.owner}}"
1032
+ * example:
1033
+ * {{entity.owner}}
1034
+ */
1035
+ variable: string;
1036
+ /**
1037
+ * The resolved value after variable evaluation (populated during execution)
1038
+ * example:
1039
+ * user_12345
1040
+ */
1041
+ value?: string;
1042
+ }
1043
+ /**
1044
+ * Version of the workflow schema.
1045
+ *
1046
+ * - `v1` – *Deprecated*. The initial version of workflows with limited structure and automation capabilities.
1047
+ * - `v2` – Linear workflows. Supports sequential task execution with basic automation triggers.
1048
+ * - `v3` – Advanced workflows. Adds support for branching logic (conditions), parallel paths, and enhanced automation features such as dynamic triggers and flow control.
1049
+ *
1050
+ * example:
1051
+ * 2
1052
+ */
1053
+ export type Version = "v1" | "v2" | "v3";
1054
+ export interface WorkflowDefinition {
1055
+ id?: string;
1056
+ name: string;
1057
+ description?: string;
1058
+ /**
1059
+ * ISO String Date & Time
1060
+ * example:
1061
+ * 2021-04-27T12:01:13.000Z
1062
+ */
1063
+ creationTime?: string;
1064
+ /**
1065
+ * Whether the workflow is enabled or not
1066
+ */
1067
+ enabled?: boolean;
1068
+ /**
1069
+ * ISO String Date & Time
1070
+ * example:
1071
+ * 2021-04-27T12:01:13.000Z
1072
+ */
1073
+ lastUpdateTime?: string;
1074
+ /**
1075
+ * example:
1076
+ * 2021-04-27T12:00:00.000Z
1077
+ */
1078
+ dueDate?: string;
1079
+ dynamicDueDate?: /* set a Duedate for a step then a specific */ DynamicDueDate;
1080
+ /**
1081
+ * This field is deprecated. Please use assignedTo
1082
+ */
1083
+ userIds?: number[];
1084
+ assignedTo?: string[];
1085
+ /**
1086
+ * Indicates whether this workflow is available for End Customer Portal or not. By default it's not.
1087
+ */
1088
+ enableECPWorkflow?: boolean;
1089
+ flow: (/* A group of Steps that define the progress of the Workflow */ Section | /* Action that needs to be done in a Workflow */ Step)[];
1090
+ closingReasons?: ClosingReasonId[];
1091
+ updateEntityAttributes?: UpdateEntityAttributes[];
1092
+ /**
1093
+ * Taxonomy ids that are associated with this workflow and used for filtering
1094
+ */
1095
+ taxonomies?: string[];
1096
+ /**
1097
+ * Whether only a single closing reason can be selected
1098
+ */
1099
+ singleClosingReasonSelection?: boolean;
1100
+ }
1101
+ }
1102
+ }
1103
+ declare namespace Paths {
1104
+ namespace ChangeReasonStatus {
1105
+ namespace Parameters {
1106
+ export type ReasonId = string;
1107
+ }
1108
+ export interface PathParameters {
1109
+ reasonId: Parameters.ReasonId;
1110
+ }
1111
+ export type RequestBody = Components.Schemas.ChangeReasonStatusReq;
1112
+ namespace Responses {
1113
+ export interface $202 {
1114
+ }
1115
+ export type $400 = Components.Schemas.ErrorResp;
1116
+ export type $500 = Components.Schemas.ErrorResp;
1117
+ }
1118
+ }
1119
+ namespace CreateClosingReason {
1120
+ export type RequestBody = /* One Closing reason for a workflow */ Components.Schemas.ClosingReason;
1121
+ namespace Responses {
1122
+ export type $201 = /* One Closing reason for a workflow */ Components.Schemas.ClosingReason;
1123
+ }
1124
+ }
1125
+ namespace CreateDefinition {
1126
+ export type RequestBody = Components.Schemas.WorkflowDefinition;
1127
+ namespace Responses {
1128
+ export type $201 = Components.Schemas.WorkflowDefinition;
1129
+ export type $400 = Components.Schemas.ErrorResp;
1130
+ export type $401 = Components.Schemas.ErrorResp;
1131
+ export type $500 = Components.Schemas.ErrorResp;
1132
+ }
1133
+ }
1134
+ namespace CreateFlowTemplate {
1135
+ export type RequestBody = Components.Schemas.CreateFlowTemplate;
1136
+ namespace Responses {
1137
+ export type $201 = Components.Schemas.FlowTemplate;
1138
+ export type $400 = Components.Schemas.ErrorResp;
1139
+ export type $401 = Components.Schemas.ErrorResp;
1140
+ export type $500 = Components.Schemas.ErrorResp;
1141
+ }
1142
+ }
1143
+ namespace DeleteClosingReason {
1144
+ namespace Parameters {
1145
+ /**
1146
+ * example:
1147
+ * x739cew
1148
+ */
1149
+ export type ReasonId = string;
1150
+ }
1151
+ export interface PathParameters {
1152
+ reasonId: /**
1153
+ * example:
1154
+ * x739cew
1155
+ */
1156
+ Parameters.ReasonId;
1157
+ }
1158
+ namespace Responses {
1159
+ export interface $204 {
1160
+ }
1161
+ export type $403 = Components.Schemas.ErrorResp;
1162
+ export type $404 = /* Closing reason could be not found */ Components.Schemas.ClosingReasonNotFoundResp;
1163
+ }
1164
+ }
1165
+ namespace DeleteDefinition {
1166
+ namespace Parameters {
1167
+ export type DefinitionId = string;
1168
+ }
1169
+ export interface PathParameters {
1170
+ definitionId: Parameters.DefinitionId;
1171
+ }
1172
+ namespace Responses {
1173
+ export interface $204 {
1174
+ }
1175
+ export type $401 = Components.Schemas.ErrorResp;
1176
+ export interface $404 {
1177
+ }
1178
+ }
1179
+ }
1180
+ namespace DeleteFlowTemplate {
1181
+ namespace Parameters {
1182
+ export type FlowId = /**
1183
+ * Short unique id (length 8) to identify the Flow Template.
1184
+ * example:
1185
+ * 7hj28akg
1186
+ */
1187
+ Components.Schemas.FlowTemplateId;
1188
+ }
1189
+ export interface PathParameters {
1190
+ flowId: Parameters.FlowId;
1191
+ }
1192
+ namespace Responses {
1193
+ export interface $204 {
1194
+ }
1195
+ export type $401 = Components.Schemas.ErrorResp;
1196
+ export interface $404 {
1197
+ }
1198
+ }
1199
+ }
1200
+ namespace DuplicateFlowTemplate {
1201
+ namespace Parameters {
1202
+ export type FlowId = /**
1203
+ * Short unique id (length 8) to identify the Flow Template.
1204
+ * example:
1205
+ * 7hj28akg
1206
+ */
1207
+ Components.Schemas.FlowTemplateId;
1208
+ }
1209
+ export interface PathParameters {
1210
+ flowId: Parameters.FlowId;
1211
+ }
1212
+ namespace Responses {
1213
+ export type $201 = Components.Schemas.FlowTemplate;
1214
+ export type $400 = Components.Schemas.ErrorResp;
1215
+ export type $401 = Components.Schemas.ErrorResp;
1216
+ export type $500 = Components.Schemas.ErrorResp;
1217
+ }
1218
+ }
1219
+ namespace ExportFlowTemplate {
1220
+ namespace Parameters {
1221
+ export type FlowId = /**
1222
+ * Short unique id (length 8) to identify the Flow Template.
1223
+ * example:
1224
+ * 7hj28akg
1225
+ */
1226
+ Components.Schemas.FlowTemplateId;
1227
+ }
1228
+ export interface PathParameters {
1229
+ flowId: Parameters.FlowId;
1230
+ }
1231
+ namespace Responses {
1232
+ export type $200 = Components.Schemas.FlowTemplateExport;
1233
+ export type $401 = Components.Schemas.ErrorResp;
1234
+ export type $404 = Components.Schemas.ErrorResp;
1235
+ export type $500 = Components.Schemas.ErrorResp;
1236
+ }
1237
+ }
1238
+ namespace GetAllClosingReasons {
1239
+ namespace Parameters {
1240
+ export type IncludeInactive = boolean;
1241
+ }
1242
+ export interface QueryParameters {
1243
+ includeInactive?: Parameters.IncludeInactive;
1244
+ }
1245
+ namespace Responses {
1246
+ export type $200 = Components.Schemas.ClosingReasons;
1247
+ }
1248
+ }
1249
+ namespace GetClosingReason {
1250
+ namespace Parameters {
1251
+ /**
1252
+ * example:
1253
+ * x739cew
1254
+ */
1255
+ export type ReasonId = string;
1256
+ }
1257
+ export interface PathParameters {
1258
+ reasonId: /**
1259
+ * example:
1260
+ * x739cew
1261
+ */
1262
+ Parameters.ReasonId;
1263
+ }
1264
+ namespace Responses {
1265
+ export type $200 = /* One Closing reason for a workflow */ Components.Schemas.ClosingReason;
1266
+ export type $400 = Components.Schemas.ErrorResp;
1267
+ export type $403 = Components.Schemas.ErrorResp;
1268
+ export type $404 = /* Closing reason could be not found */ Components.Schemas.ClosingReasonNotFoundResp;
1269
+ }
1270
+ }
1271
+ namespace GetClosingReasonV1 {
1272
+ namespace Parameters {
1273
+ export type ReasonId = string;
1274
+ }
1275
+ export interface PathParameters {
1276
+ reasonId: Parameters.ReasonId;
1277
+ }
1278
+ namespace Responses {
1279
+ export type $200 = /* One Closing reason for a workflow */ Components.Schemas.ClosingReason;
1280
+ export type $400 = Components.Schemas.ErrorResp;
1281
+ export type $401 = Components.Schemas.ErrorResp;
1282
+ export type $404 = /* Closing reason could be not found */ Components.Schemas.ClosingReasonNotFoundResp;
1283
+ export type $500 = Components.Schemas.ErrorResp;
1284
+ }
1285
+ }
1286
+ namespace GetDefinition {
1287
+ namespace Parameters {
1288
+ export type DefinitionId = string;
1289
+ }
1290
+ export interface PathParameters {
1291
+ definitionId: Parameters.DefinitionId;
1292
+ }
1293
+ namespace Responses {
1294
+ export type $200 = Components.Schemas.WorkflowDefinition;
1295
+ export type $400 = Components.Schemas.ErrorResp;
1296
+ export type $401 = Components.Schemas.ErrorResp;
1297
+ export type $404 = /* Definition could be not found */ Components.Schemas.DefinitionNotFoundResp;
1298
+ export type $500 = Components.Schemas.ErrorResp;
1299
+ }
1300
+ }
1301
+ namespace GetDefinitions {
1302
+ namespace Responses {
1303
+ export type $200 = Components.Schemas.WorkflowDefinition[];
1304
+ export type $500 = Components.Schemas.ErrorResp;
1305
+ }
1306
+ }
1307
+ namespace GetFlowTemplate {
1308
+ namespace Parameters {
1309
+ export type FlowId = /**
1310
+ * Short unique id (length 8) to identify the Flow Template.
1311
+ * example:
1312
+ * 7hj28akg
1313
+ */
1314
+ Components.Schemas.FlowTemplateId;
1315
+ }
1316
+ export interface PathParameters {
1317
+ flowId: Parameters.FlowId;
1318
+ }
1319
+ namespace Responses {
1320
+ export type $200 = Components.Schemas.FlowTemplate;
1321
+ export type $400 = Components.Schemas.ErrorResp;
1322
+ export type $401 = Components.Schemas.ErrorResp;
1323
+ export type $404 = /* Definition could be not found */ Components.Schemas.DefinitionNotFoundResp;
1324
+ export type $500 = Components.Schemas.ErrorResp;
1325
+ }
1326
+ }
1327
+ namespace GetMaxAllowedLimit {
1328
+ namespace Responses {
1329
+ export type $200 = Components.Schemas.MaxAllowedLimit;
1330
+ export type $500 = Components.Schemas.ErrorResp;
1331
+ }
1332
+ }
1333
+ namespace GetWorkflowClosingReasons {
1334
+ namespace Parameters {
1335
+ export type DefinitionId = string;
1336
+ }
1337
+ export interface PathParameters {
1338
+ definitionId: Parameters.DefinitionId;
1339
+ }
1340
+ namespace Responses {
1341
+ export type $200 = Components.Schemas.ClosingReasonsIds;
1342
+ }
1343
+ }
1344
+ namespace ImportFlowTemplate {
1345
+ export type RequestBody = Components.Schemas.FlowTemplateExport;
1346
+ namespace Responses {
1347
+ export type $201 = Components.Schemas.FlowTemplateImportResult;
1348
+ export type $400 = Components.Schemas.ErrorResp;
1349
+ export type $401 = Components.Schemas.ErrorResp;
1350
+ export type $500 = Components.Schemas.ErrorResp;
1351
+ }
1352
+ }
1353
+ namespace ListFlowTemplates {
1354
+ namespace Parameters {
1355
+ export type TriggerSchema = string;
1356
+ export type TriggerSourceId = string;
1357
+ export type TriggerType = "automation" | "manual" | "journey_submission";
1358
+ }
1359
+ export interface QueryParameters {
1360
+ trigger_type?: Parameters.TriggerType;
1361
+ trigger_source_id?: Parameters.TriggerSourceId;
1362
+ trigger_schema?: Parameters.TriggerSchema;
1363
+ }
1364
+ namespace Responses {
1365
+ export type $200 = Components.Schemas.FlowTemplatesList;
1366
+ export type $500 = Components.Schemas.ErrorResp;
1367
+ }
1368
+ }
1369
+ namespace SearchFlowTemplates {
1370
+ export type RequestBody = Components.Schemas.SearchFlowTemplates;
1371
+ namespace Responses {
1372
+ export interface $200 {
1373
+ hits?: number;
1374
+ results?: Components.Schemas.FlowTemplate[];
1375
+ }
1376
+ export type $500 = Components.Schemas.ErrorResp;
1377
+ }
1378
+ }
1379
+ namespace SetWorkflowClosingReasons {
1380
+ namespace Parameters {
1381
+ export type DefinitionId = string;
1382
+ }
1383
+ export interface PathParameters {
1384
+ definitionId: Parameters.DefinitionId;
1385
+ }
1386
+ export type RequestBody = Components.Schemas.ClosingReasonsIds;
1387
+ namespace Responses {
1388
+ export interface $201 {
1389
+ }
1390
+ }
1391
+ }
1392
+ namespace UpdateClosingReason {
1393
+ namespace Parameters {
1394
+ /**
1395
+ * example:
1396
+ * x739cew
1397
+ */
1398
+ export type ReasonId = string;
1399
+ }
1400
+ export interface PathParameters {
1401
+ reasonId: /**
1402
+ * example:
1403
+ * x739cew
1404
+ */
1405
+ Parameters.ReasonId;
1406
+ }
1407
+ export type RequestBody = /* One Closing reason for a workflow */ Components.Schemas.ClosingReason;
1408
+ namespace Responses {
1409
+ export type $200 = /* One Closing reason for a workflow */ Components.Schemas.ClosingReason;
1410
+ export type $400 = Components.Schemas.ErrorResp;
1411
+ export type $403 = Components.Schemas.ErrorResp;
1412
+ export type $404 = /* Closing reason could be not found */ Components.Schemas.ClosingReasonNotFoundResp;
1413
+ }
1414
+ }
1415
+ namespace UpdateDefinition {
1416
+ namespace Parameters {
1417
+ export type DefinitionId = string;
1418
+ }
1419
+ export interface PathParameters {
1420
+ definitionId: Parameters.DefinitionId;
1421
+ }
1422
+ export type RequestBody = Components.Schemas.WorkflowDefinition;
1423
+ namespace Responses {
1424
+ export type $200 = Components.Schemas.WorkflowDefinition;
1425
+ export type $400 = Components.Schemas.ErrorResp;
1426
+ export type $401 = Components.Schemas.ErrorResp;
1427
+ export type $500 = Components.Schemas.ErrorResp;
1428
+ }
1429
+ }
1430
+ namespace UpdateFlowTemplate {
1431
+ namespace Parameters {
1432
+ export type FlowId = /**
1433
+ * Short unique id (length 8) to identify the Flow Template.
1434
+ * example:
1435
+ * 7hj28akg
1436
+ */
1437
+ Components.Schemas.FlowTemplateId;
1438
+ }
1439
+ export interface PathParameters {
1440
+ flowId: Parameters.FlowId;
1441
+ }
1442
+ export type RequestBody = Components.Schemas.FlowTemplate;
1443
+ namespace Responses {
1444
+ export type $200 = Components.Schemas.FlowTemplate;
1445
+ export type $400 = Components.Schemas.ErrorResp;
1446
+ export type $401 = Components.Schemas.ErrorResp;
1447
+ export type $500 = Components.Schemas.ErrorResp;
1448
+ }
1449
+ }
1450
+ }
1451
+
1452
+
1453
+ interface OperationMethods {
1454
+ /**
1455
+ * getMaxAllowedLimit - getMaxAllowedLimit
1456
+ *
1457
+ * Get limits and number of created executions for an Organization.
1458
+ */
1459
+ 'getMaxAllowedLimit'(
1460
+ parameters?: Parameters<UnknownParamsObject> | null,
1461
+ data?: any,
1462
+ config?: AxiosRequestConfig
1463
+ ): OperationResponse<Paths.GetMaxAllowedLimit.Responses.$200>
1464
+ /**
1465
+ * getDefinitions - getDefinitions
1466
+ *
1467
+ * Retrieve all Workflow Definitions from an Organization
1468
+ */
1469
+ 'getDefinitions'(
1470
+ parameters?: Parameters<UnknownParamsObject> | null,
1471
+ data?: any,
1472
+ config?: AxiosRequestConfig
1473
+ ): OperationResponse<Paths.GetDefinitions.Responses.$200>
1474
+ /**
1475
+ * createDefinition - createDefinition
1476
+ *
1477
+ * Create a Workflow Definition.
1478
+ */
1479
+ 'createDefinition'(
1480
+ parameters?: Parameters<UnknownParamsObject> | null,
1481
+ data?: Paths.CreateDefinition.RequestBody,
1482
+ config?: AxiosRequestConfig
1483
+ ): OperationResponse<Paths.CreateDefinition.Responses.$201>
1484
+ /**
1485
+ * listFlowTemplates - listFlowTemplates
1486
+ *
1487
+ * List all Flow Templates for a customer. Optionally, you can filter flow templates by trigger values.
1488
+ */
1489
+ 'listFlowTemplates'(
1490
+ parameters?: Parameters<Paths.ListFlowTemplates.QueryParameters> | null,
1491
+ data?: any,
1492
+ config?: AxiosRequestConfig
1493
+ ): OperationResponse<Paths.ListFlowTemplates.Responses.$200>
1494
+ /**
1495
+ * createFlowTemplate - createFlowTemplate
1496
+ *
1497
+ * Create a new Flow Template.
1498
+ */
1499
+ 'createFlowTemplate'(
1500
+ parameters?: Parameters<UnknownParamsObject> | null,
1501
+ data?: Paths.CreateFlowTemplate.RequestBody,
1502
+ config?: AxiosRequestConfig
1503
+ ): OperationResponse<Paths.CreateFlowTemplate.Responses.$201>
1504
+ /**
1505
+ * searchFlowTemplates - searchFlowTemplates
1506
+ *
1507
+ * Search for flow templates by name, trigger type, enabled status, and more.
1508
+ */
1509
+ 'searchFlowTemplates'(
1510
+ parameters?: Parameters<UnknownParamsObject> | null,
1511
+ data?: Paths.SearchFlowTemplates.RequestBody,
1512
+ config?: AxiosRequestConfig
1513
+ ): OperationResponse<Paths.SearchFlowTemplates.Responses.$200>
1514
+ /**
1515
+ * getFlowTemplate - getFlowTemplate
1516
+ *
1517
+ * Get specific FLow template for a customer
1518
+ */
1519
+ 'getFlowTemplate'(
1520
+ parameters?: Parameters<Paths.GetFlowTemplate.PathParameters> | null,
1521
+ data?: any,
1522
+ config?: AxiosRequestConfig
1523
+ ): OperationResponse<Paths.GetFlowTemplate.Responses.$200>
1524
+ /**
1525
+ * updateFlowTemplate - updateFlowTemplate
1526
+ *
1527
+ * Update Flow Template.
1528
+ */
1529
+ 'updateFlowTemplate'(
1530
+ parameters?: Parameters<Paths.UpdateFlowTemplate.PathParameters> | null,
1531
+ data?: Paths.UpdateFlowTemplate.RequestBody,
1532
+ config?: AxiosRequestConfig
1533
+ ): OperationResponse<Paths.UpdateFlowTemplate.Responses.$200>
1534
+ /**
1535
+ * deleteFlowTemplate - deleteFlowTemplate
1536
+ *
1537
+ * Delete Flow Template.
1538
+ */
1539
+ 'deleteFlowTemplate'(
1540
+ parameters?: Parameters<Paths.DeleteFlowTemplate.PathParameters> | null,
1541
+ data?: any,
1542
+ config?: AxiosRequestConfig
1543
+ ): OperationResponse<Paths.DeleteFlowTemplate.Responses.$204>
1544
+ /**
1545
+ * duplicateFlowTemplate - duplicateFlowTemplate
1546
+ *
1547
+ * Duplicate a Flow Template from an existing workflow.
1548
+ */
1549
+ 'duplicateFlowTemplate'(
1550
+ parameters?: Parameters<Paths.DuplicateFlowTemplate.PathParameters> | null,
1551
+ data?: any,
1552
+ config?: AxiosRequestConfig
1553
+ ): OperationResponse<Paths.DuplicateFlowTemplate.Responses.$201>
1554
+ /**
1555
+ * exportFlowTemplate - exportFlowTemplate
1556
+ *
1557
+ * Export a Flow Template with all referenced automations resolved and bundled alongside.
1558
+ */
1559
+ 'exportFlowTemplate'(
1560
+ parameters?: Parameters<Paths.ExportFlowTemplate.PathParameters> | null,
1561
+ data?: any,
1562
+ config?: AxiosRequestConfig
1563
+ ): OperationResponse<Paths.ExportFlowTemplate.Responses.$200>
1564
+ /**
1565
+ * importFlowTemplate - importFlowTemplate
1566
+ *
1567
+ * Import a Flow Template from an export payload. Creates all automations and the flow in the caller's organization.
1568
+ */
1569
+ 'importFlowTemplate'(
1570
+ parameters?: Parameters<UnknownParamsObject> | null,
1571
+ data?: Paths.ImportFlowTemplate.RequestBody,
1572
+ config?: AxiosRequestConfig
1573
+ ): OperationResponse<Paths.ImportFlowTemplate.Responses.$201>
1574
+ /**
1575
+ * getDefinition - getDefinition
1576
+ *
1577
+ * Get specific Definition by id from the Organization.
1578
+ */
1579
+ 'getDefinition'(
1580
+ parameters?: Parameters<Paths.GetDefinition.PathParameters> | null,
1581
+ data?: any,
1582
+ config?: AxiosRequestConfig
1583
+ ): OperationResponse<Paths.GetDefinition.Responses.$200>
1584
+ /**
1585
+ * updateDefinition - updateDefinition
1586
+ *
1587
+ * Update Workflow Definition.
1588
+ */
1589
+ 'updateDefinition'(
1590
+ parameters?: Parameters<Paths.UpdateDefinition.PathParameters> | null,
1591
+ data?: Paths.UpdateDefinition.RequestBody,
1592
+ config?: AxiosRequestConfig
1593
+ ): OperationResponse<Paths.UpdateDefinition.Responses.$200>
1594
+ /**
1595
+ * deleteDefinition - deleteDefinition
1596
+ *
1597
+ * Delete Workflow Definition.
1598
+ */
1599
+ 'deleteDefinition'(
1600
+ parameters?: Parameters<Paths.DeleteDefinition.PathParameters> | null,
1601
+ data?: any,
1602
+ config?: AxiosRequestConfig
1603
+ ): OperationResponse<Paths.DeleteDefinition.Responses.$204>
1604
+ /**
1605
+ * getAllClosingReasons - getAllClosingReasons
1606
+ *
1607
+ * Get all Closing Reasons defined in the organization by default all Active.
1608
+ */
1609
+ 'getAllClosingReasons'(
1610
+ parameters?: Parameters<Paths.GetAllClosingReasons.QueryParameters> | null,
1611
+ data?: any,
1612
+ config?: AxiosRequestConfig
1613
+ ): OperationResponse<Paths.GetAllClosingReasons.Responses.$200>
1614
+ /**
1615
+ * createClosingReason - createClosingReason
1616
+ *
1617
+ * A created Closing Reason is stored for the organization and will be displayed in the library of reasons.
1618
+ */
1619
+ 'createClosingReason'(
1620
+ parameters?: Parameters<UnknownParamsObject> | null,
1621
+ data?: Paths.CreateClosingReason.RequestBody,
1622
+ config?: AxiosRequestConfig
1623
+ ): OperationResponse<Paths.CreateClosingReason.Responses.$201>
1624
+ /**
1625
+ * getClosingReason - getClosingReason
1626
+ *
1627
+ * Get specific closing reason by id from the organisation.
1628
+ */
1629
+ 'getClosingReason'(
1630
+ parameters?: Parameters<Paths.GetClosingReason.PathParameters> | null,
1631
+ data?: any,
1632
+ config?: AxiosRequestConfig
1633
+ ): OperationResponse<Paths.GetClosingReason.Responses.$200>
1634
+ /**
1635
+ * updateClosingReason - updateClosingReason
1636
+ *
1637
+ * Update an existing closing reason
1638
+ */
1639
+ 'updateClosingReason'(
1640
+ parameters?: Parameters<Paths.UpdateClosingReason.PathParameters> | null,
1641
+ data?: Paths.UpdateClosingReason.RequestBody,
1642
+ config?: AxiosRequestConfig
1643
+ ): OperationResponse<Paths.UpdateClosingReason.Responses.$200>
1644
+ /**
1645
+ * deleteClosingReason - deleteClosingReason
1646
+ *
1647
+ * Permanently delete a closing reason (Using INACTIVE status is recommended instead)
1648
+ */
1649
+ 'deleteClosingReason'(
1650
+ parameters?: Parameters<Paths.DeleteClosingReason.PathParameters> | null,
1651
+ data?: any,
1652
+ config?: AxiosRequestConfig
1653
+ ): OperationResponse<Paths.DeleteClosingReason.Responses.$204>
1654
+ /**
1655
+ * getClosingReasonV1 - getClosingReasonV1
1656
+ *
1657
+ * Get specific closing reason by id from the organisation.
1658
+ */
1659
+ 'getClosingReasonV1'(
1660
+ parameters?: Parameters<Paths.GetClosingReasonV1.PathParameters> | null,
1661
+ data?: any,
1662
+ config?: AxiosRequestConfig
1663
+ ): OperationResponse<Paths.GetClosingReasonV1.Responses.$200>
1664
+ /**
1665
+ * changeReasonStatus - changeReasonStatus
1666
+ *
1667
+ * Change the status of a Closing Reason (eg. ACTIVE to INACTIVE).
1668
+ */
1669
+ 'changeReasonStatus'(
1670
+ parameters?: Parameters<Paths.ChangeReasonStatus.PathParameters> | null,
1671
+ data?: Paths.ChangeReasonStatus.RequestBody,
1672
+ config?: AxiosRequestConfig
1673
+ ): OperationResponse<Paths.ChangeReasonStatus.Responses.$202>
1674
+ /**
1675
+ * getWorkflowClosingReasons - getWorkflowClosingReasons
1676
+ *
1677
+ * Returns all closing reasons defined for the workflow.
1678
+ */
1679
+ 'getWorkflowClosingReasons'(
1680
+ parameters?: Parameters<Paths.GetWorkflowClosingReasons.PathParameters> | null,
1681
+ data?: any,
1682
+ config?: AxiosRequestConfig
1683
+ ): OperationResponse<Paths.GetWorkflowClosingReasons.Responses.$200>
1684
+ /**
1685
+ * setWorkflowClosingReasons - setWorkflowClosingReasons
1686
+ *
1687
+ * Sets which closing reasons are defined for this workflow, based on the entire closing reasons catalog.
1688
+ */
1689
+ 'setWorkflowClosingReasons'(
1690
+ parameters?: Parameters<Paths.SetWorkflowClosingReasons.PathParameters> | null,
1691
+ data?: Paths.SetWorkflowClosingReasons.RequestBody,
1692
+ config?: AxiosRequestConfig
1693
+ ): OperationResponse<Paths.SetWorkflowClosingReasons.Responses.$201>
1694
+ }
1695
+
1696
+ interface PathsDictionary {
1697
+ ['/v1/workflows/limits/max-allowed']: {
1698
+ /**
1699
+ * getMaxAllowedLimit - getMaxAllowedLimit
1700
+ *
1701
+ * Get limits and number of created executions for an Organization.
1702
+ */
1703
+ 'get'(
1704
+ parameters?: Parameters<UnknownParamsObject> | null,
1705
+ data?: any,
1706
+ config?: AxiosRequestConfig
1707
+ ): OperationResponse<Paths.GetMaxAllowedLimit.Responses.$200>
1708
+ }
1709
+ ['/v1/workflows/definitions']: {
1710
+ /**
1711
+ * getDefinitions - getDefinitions
1712
+ *
1713
+ * Retrieve all Workflow Definitions from an Organization
1714
+ */
1715
+ 'get'(
1716
+ parameters?: Parameters<UnknownParamsObject> | null,
1717
+ data?: any,
1718
+ config?: AxiosRequestConfig
1719
+ ): OperationResponse<Paths.GetDefinitions.Responses.$200>
1720
+ /**
1721
+ * createDefinition - createDefinition
1722
+ *
1723
+ * Create a Workflow Definition.
1724
+ */
1725
+ 'post'(
1726
+ parameters?: Parameters<UnknownParamsObject> | null,
1727
+ data?: Paths.CreateDefinition.RequestBody,
1728
+ config?: AxiosRequestConfig
1729
+ ): OperationResponse<Paths.CreateDefinition.Responses.$201>
1730
+ }
1731
+ ['/v2/flows/templates']: {
1732
+ /**
1733
+ * listFlowTemplates - listFlowTemplates
1734
+ *
1735
+ * List all Flow Templates for a customer. Optionally, you can filter flow templates by trigger values.
1736
+ */
1737
+ 'get'(
1738
+ parameters?: Parameters<Paths.ListFlowTemplates.QueryParameters> | null,
1739
+ data?: any,
1740
+ config?: AxiosRequestConfig
1741
+ ): OperationResponse<Paths.ListFlowTemplates.Responses.$200>
1742
+ /**
1743
+ * createFlowTemplate - createFlowTemplate
1744
+ *
1745
+ * Create a new Flow Template.
1746
+ */
1747
+ 'post'(
1748
+ parameters?: Parameters<UnknownParamsObject> | null,
1749
+ data?: Paths.CreateFlowTemplate.RequestBody,
1750
+ config?: AxiosRequestConfig
1751
+ ): OperationResponse<Paths.CreateFlowTemplate.Responses.$201>
1752
+ }
1753
+ ['/v2/flows/templates:search']: {
1754
+ /**
1755
+ * searchFlowTemplates - searchFlowTemplates
1756
+ *
1757
+ * Search for flow templates by name, trigger type, enabled status, and more.
1758
+ */
1759
+ 'post'(
1760
+ parameters?: Parameters<UnknownParamsObject> | null,
1761
+ data?: Paths.SearchFlowTemplates.RequestBody,
1762
+ config?: AxiosRequestConfig
1763
+ ): OperationResponse<Paths.SearchFlowTemplates.Responses.$200>
1764
+ }
1765
+ ['/v2/flows/templates/{flowId}']: {
1766
+ /**
1767
+ * getFlowTemplate - getFlowTemplate
1768
+ *
1769
+ * Get specific FLow template for a customer
1770
+ */
1771
+ 'get'(
1772
+ parameters?: Parameters<Paths.GetFlowTemplate.PathParameters> | null,
1773
+ data?: any,
1774
+ config?: AxiosRequestConfig
1775
+ ): OperationResponse<Paths.GetFlowTemplate.Responses.$200>
1776
+ /**
1777
+ * updateFlowTemplate - updateFlowTemplate
1778
+ *
1779
+ * Update Flow Template.
1780
+ */
1781
+ 'put'(
1782
+ parameters?: Parameters<Paths.UpdateFlowTemplate.PathParameters> | null,
1783
+ data?: Paths.UpdateFlowTemplate.RequestBody,
1784
+ config?: AxiosRequestConfig
1785
+ ): OperationResponse<Paths.UpdateFlowTemplate.Responses.$200>
1786
+ /**
1787
+ * deleteFlowTemplate - deleteFlowTemplate
1788
+ *
1789
+ * Delete Flow Template.
1790
+ */
1791
+ 'delete'(
1792
+ parameters?: Parameters<Paths.DeleteFlowTemplate.PathParameters> | null,
1793
+ data?: any,
1794
+ config?: AxiosRequestConfig
1795
+ ): OperationResponse<Paths.DeleteFlowTemplate.Responses.$204>
1796
+ }
1797
+ ['/v2/flows/templates/{flowId}/duplicate']: {
1798
+ /**
1799
+ * duplicateFlowTemplate - duplicateFlowTemplate
1800
+ *
1801
+ * Duplicate a Flow Template from an existing workflow.
1802
+ */
1803
+ 'post'(
1804
+ parameters?: Parameters<Paths.DuplicateFlowTemplate.PathParameters> | null,
1805
+ data?: any,
1806
+ config?: AxiosRequestConfig
1807
+ ): OperationResponse<Paths.DuplicateFlowTemplate.Responses.$201>
1808
+ }
1809
+ ['/v2/flows/templates/{flowId}/export']: {
1810
+ /**
1811
+ * exportFlowTemplate - exportFlowTemplate
1812
+ *
1813
+ * Export a Flow Template with all referenced automations resolved and bundled alongside.
1814
+ */
1815
+ 'get'(
1816
+ parameters?: Parameters<Paths.ExportFlowTemplate.PathParameters> | null,
1817
+ data?: any,
1818
+ config?: AxiosRequestConfig
1819
+ ): OperationResponse<Paths.ExportFlowTemplate.Responses.$200>
1820
+ }
1821
+ ['/v2/flows/templates/import']: {
1822
+ /**
1823
+ * importFlowTemplate - importFlowTemplate
1824
+ *
1825
+ * Import a Flow Template from an export payload. Creates all automations and the flow in the caller's organization.
1826
+ */
1827
+ 'post'(
1828
+ parameters?: Parameters<UnknownParamsObject> | null,
1829
+ data?: Paths.ImportFlowTemplate.RequestBody,
1830
+ config?: AxiosRequestConfig
1831
+ ): OperationResponse<Paths.ImportFlowTemplate.Responses.$201>
1832
+ }
1833
+ ['/v1/workflows/definitions/{definitionId}']: {
1834
+ /**
1835
+ * getDefinition - getDefinition
1836
+ *
1837
+ * Get specific Definition by id from the Organization.
1838
+ */
1839
+ 'get'(
1840
+ parameters?: Parameters<Paths.GetDefinition.PathParameters> | null,
1841
+ data?: any,
1842
+ config?: AxiosRequestConfig
1843
+ ): OperationResponse<Paths.GetDefinition.Responses.$200>
1844
+ /**
1845
+ * updateDefinition - updateDefinition
1846
+ *
1847
+ * Update Workflow Definition.
1848
+ */
1849
+ 'put'(
1850
+ parameters?: Parameters<Paths.UpdateDefinition.PathParameters> | null,
1851
+ data?: Paths.UpdateDefinition.RequestBody,
1852
+ config?: AxiosRequestConfig
1853
+ ): OperationResponse<Paths.UpdateDefinition.Responses.$200>
1854
+ /**
1855
+ * deleteDefinition - deleteDefinition
1856
+ *
1857
+ * Delete Workflow Definition.
1858
+ */
1859
+ 'delete'(
1860
+ parameters?: Parameters<Paths.DeleteDefinition.PathParameters> | null,
1861
+ data?: any,
1862
+ config?: AxiosRequestConfig
1863
+ ): OperationResponse<Paths.DeleteDefinition.Responses.$204>
1864
+ }
1865
+ ['/v1/workflows/closing-reasons']: {
1866
+ /**
1867
+ * getAllClosingReasons - getAllClosingReasons
1868
+ *
1869
+ * Get all Closing Reasons defined in the organization by default all Active.
1870
+ */
1871
+ 'get'(
1872
+ parameters?: Parameters<Paths.GetAllClosingReasons.QueryParameters> | null,
1873
+ data?: any,
1874
+ config?: AxiosRequestConfig
1875
+ ): OperationResponse<Paths.GetAllClosingReasons.Responses.$200>
1876
+ /**
1877
+ * createClosingReason - createClosingReason
1878
+ *
1879
+ * A created Closing Reason is stored for the organization and will be displayed in the library of reasons.
1880
+ */
1881
+ 'post'(
1882
+ parameters?: Parameters<UnknownParamsObject> | null,
1883
+ data?: Paths.CreateClosingReason.RequestBody,
1884
+ config?: AxiosRequestConfig
1885
+ ): OperationResponse<Paths.CreateClosingReason.Responses.$201>
1886
+ }
1887
+ ['/v2/workflows/closing-reasons/{reasonId}']: {
1888
+ /**
1889
+ * getClosingReason - getClosingReason
1890
+ *
1891
+ * Get specific closing reason by id from the organisation.
1892
+ */
1893
+ 'get'(
1894
+ parameters?: Parameters<Paths.GetClosingReason.PathParameters> | null,
1895
+ data?: any,
1896
+ config?: AxiosRequestConfig
1897
+ ): OperationResponse<Paths.GetClosingReason.Responses.$200>
1898
+ /**
1899
+ * updateClosingReason - updateClosingReason
1900
+ *
1901
+ * Update an existing closing reason
1902
+ */
1903
+ 'patch'(
1904
+ parameters?: Parameters<Paths.UpdateClosingReason.PathParameters> | null,
1905
+ data?: Paths.UpdateClosingReason.RequestBody,
1906
+ config?: AxiosRequestConfig
1907
+ ): OperationResponse<Paths.UpdateClosingReason.Responses.$200>
1908
+ /**
1909
+ * deleteClosingReason - deleteClosingReason
1910
+ *
1911
+ * Permanently delete a closing reason (Using INACTIVE status is recommended instead)
1912
+ */
1913
+ 'delete'(
1914
+ parameters?: Parameters<Paths.DeleteClosingReason.PathParameters> | null,
1915
+ data?: any,
1916
+ config?: AxiosRequestConfig
1917
+ ): OperationResponse<Paths.DeleteClosingReason.Responses.$204>
1918
+ }
1919
+ ['/v1/workflows/closing-reasons/{reasonId}']: {
1920
+ /**
1921
+ * getClosingReasonV1 - getClosingReasonV1
1922
+ *
1923
+ * Get specific closing reason by id from the organisation.
1924
+ */
1925
+ 'get'(
1926
+ parameters?: Parameters<Paths.GetClosingReasonV1.PathParameters> | null,
1927
+ data?: any,
1928
+ config?: AxiosRequestConfig
1929
+ ): OperationResponse<Paths.GetClosingReasonV1.Responses.$200>
1930
+ /**
1931
+ * changeReasonStatus - changeReasonStatus
1932
+ *
1933
+ * Change the status of a Closing Reason (eg. ACTIVE to INACTIVE).
1934
+ */
1935
+ 'patch'(
1936
+ parameters?: Parameters<Paths.ChangeReasonStatus.PathParameters> | null,
1937
+ data?: Paths.ChangeReasonStatus.RequestBody,
1938
+ config?: AxiosRequestConfig
1939
+ ): OperationResponse<Paths.ChangeReasonStatus.Responses.$202>
1940
+ }
1941
+ ['/v1/workflows/definitions/{definitionId}/closing-reasons']: {
1942
+ /**
1943
+ * getWorkflowClosingReasons - getWorkflowClosingReasons
1944
+ *
1945
+ * Returns all closing reasons defined for the workflow.
1946
+ */
1947
+ 'get'(
1948
+ parameters?: Parameters<Paths.GetWorkflowClosingReasons.PathParameters> | null,
1949
+ data?: any,
1950
+ config?: AxiosRequestConfig
1951
+ ): OperationResponse<Paths.GetWorkflowClosingReasons.Responses.$200>
1952
+ /**
1953
+ * setWorkflowClosingReasons - setWorkflowClosingReasons
1954
+ *
1955
+ * Sets which closing reasons are defined for this workflow, based on the entire closing reasons catalog.
1956
+ */
1957
+ 'patch'(
1958
+ parameters?: Parameters<Paths.SetWorkflowClosingReasons.PathParameters> | null,
1959
+ data?: Paths.SetWorkflowClosingReasons.RequestBody,
1960
+ config?: AxiosRequestConfig
1961
+ ): OperationResponse<Paths.SetWorkflowClosingReasons.Responses.$201>
1962
+ }
1963
+ }
1964
+
1965
+ type Client = OpenAPIClient<OperationMethods, PathsDictionary>
1966
+
1967
+
1968
+ type ActionSchedule = Components.Schemas.ActionSchedule;
1969
+ type AgentConfig = Components.Schemas.AgentConfig;
1970
+ type AiAgentTask = Components.Schemas.AiAgentTask;
1971
+ type AutomationConfig = Components.Schemas.AutomationConfig;
1972
+ type AutomationTask = Components.Schemas.AutomationTask;
1973
+ type AutomationTrigger = Components.Schemas.AutomationTrigger;
1974
+ type ChangeReasonStatusReq = Components.Schemas.ChangeReasonStatusReq;
1975
+ type ClosingReason = Components.Schemas.ClosingReason;
1976
+ type ClosingReasonId = Components.Schemas.ClosingReasonId;
1977
+ type ClosingReasonNotFoundResp = Components.Schemas.ClosingReasonNotFoundResp;
1978
+ type ClosingReasons = Components.Schemas.ClosingReasons;
1979
+ type ClosingReasonsIds = Components.Schemas.ClosingReasonsIds;
1980
+ type ClosingReasonsStatus = Components.Schemas.ClosingReasonsStatus;
1981
+ type Condition = Components.Schemas.Condition;
1982
+ type CreateFlowTemplate = Components.Schemas.CreateFlowTemplate;
1983
+ type DecisionTask = Components.Schemas.DecisionTask;
1984
+ type DefinitionNotFoundResp = Components.Schemas.DefinitionNotFoundResp;
1985
+ type DelayedSchedule = Components.Schemas.DelayedSchedule;
1986
+ type DueDateConfig = Components.Schemas.DueDateConfig;
1987
+ type DynamicDueDate = Components.Schemas.DynamicDueDate;
1988
+ type ECPDetails = Components.Schemas.ECPDetails;
1989
+ type Edge = Components.Schemas.Edge;
1990
+ type EnableRequirement = Components.Schemas.EnableRequirement;
1991
+ type EntitySync = Components.Schemas.EntitySync;
1992
+ type ErrorResp = Components.Schemas.ErrorResp;
1993
+ type EvaluationSource = Components.Schemas.EvaluationSource;
1994
+ type FlowTemplate = Components.Schemas.FlowTemplate;
1995
+ type FlowTemplateBase = Components.Schemas.FlowTemplateBase;
1996
+ type FlowTemplateExport = Components.Schemas.FlowTemplateExport;
1997
+ type FlowTemplateId = Components.Schemas.FlowTemplateId;
1998
+ type FlowTemplateImportResult = Components.Schemas.FlowTemplateImportResult;
1999
+ type FlowTemplatesList = Components.Schemas.FlowTemplatesList;
2000
+ type ImmediateSchedule = Components.Schemas.ImmediateSchedule;
2001
+ type ItemType = Components.Schemas.ItemType;
2002
+ type JourneyAutomationTrigger = Components.Schemas.JourneyAutomationTrigger;
2003
+ type JourneySubmissionTrigger = Components.Schemas.JourneySubmissionTrigger;
2004
+ type ManualTask = Components.Schemas.ManualTask;
2005
+ type ManualTrigger = Components.Schemas.ManualTrigger;
2006
+ type MaxAllowedLimit = Components.Schemas.MaxAllowedLimit;
2007
+ type Operator = Components.Schemas.Operator;
2008
+ type Phase = Components.Schemas.Phase;
2009
+ type RelativeSchedule = Components.Schemas.RelativeSchedule;
2010
+ type SearchFlowTemplates = Components.Schemas.SearchFlowTemplates;
2011
+ type Section = Components.Schemas.Section;
2012
+ type Statement = Components.Schemas.Statement;
2013
+ type Step = Components.Schemas.Step;
2014
+ type StepDescription = Components.Schemas.StepDescription;
2015
+ type StepJourney = Components.Schemas.StepJourney;
2016
+ type StepRequirement = Components.Schemas.StepRequirement;
2017
+ type StepType = Components.Schemas.StepType;
2018
+ type Task = Components.Schemas.Task;
2019
+ type TaskBase = Components.Schemas.TaskBase;
2020
+ type TaskType = Components.Schemas.TaskType;
2021
+ type TimeUnit = Components.Schemas.TimeUnit;
2022
+ type Trigger = Components.Schemas.Trigger;
2023
+ type TriggerMode = Components.Schemas.TriggerMode;
2024
+ type TriggerType = Components.Schemas.TriggerType;
2025
+ type UpdateEntityAttributes = Components.Schemas.UpdateEntityAttributes;
2026
+ type VariableAssignment = Components.Schemas.VariableAssignment;
2027
+ type Version = Components.Schemas.Version;
2028
+ type WorkflowDefinition = Components.Schemas.WorkflowDefinition;
2029
+
2030
+ export { type Task as $, type ActionSchedule as A, type FlowTemplateImportResult as B, type Client as C, type DecisionTask as D, type ECPDetails as E, type FlowTemplate as F, type FlowTemplatesList as G, type ItemType as H, type ImmediateSchedule as I, type JourneyAutomationTrigger as J, type JourneySubmissionTrigger as K, type ManualTrigger as L, type ManualTask as M, type MaxAllowedLimit as N, type OperationMethods as O, type PathsDictionary as P, type Operator as Q, type Phase as R, type RelativeSchedule as S, SearchFlowTemplates as T, type Section as U, type Statement as V, type Step as W, type StepDescription as X, type StepJourney as Y, type StepRequirement as Z, type StepType as _, type AgentConfig as a, type TaskBase as a0, type TaskType as a1, type TimeUnit as a2, type Trigger as a3, type TriggerMode as a4, type TriggerType as a5, type UpdateEntityAttributes as a6, type VariableAssignment as a7, type Version as a8, type WorkflowDefinition as a9, type AiAgentTask as b, type AutomationConfig as c, type AutomationTask as d, type AutomationTrigger as e, type ChangeReasonStatusReq as f, type ClosingReason as g, type ClosingReasonId as h, type ClosingReasonNotFoundResp as i, type ClosingReasons as j, type ClosingReasonsIds as k, type ClosingReasonsStatus as l, type Condition as m, CreateFlowTemplate as n, type DefinitionNotFoundResp as o, type DelayedSchedule as p, type DueDateConfig as q, type DynamicDueDate as r, type Edge as s, type EnableRequirement as t, type EntitySync as u, type ErrorResp as v, type EvaluationSource as w, type FlowTemplateBase as x, type FlowTemplateExport as y, type FlowTemplateId as z };