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