@epilot/sdk 2.1.0-rc.0 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/definitions/app.json +38 -0
- package/definitions/automation.json +2 -37
- package/definitions/blueprint-manifest-runtime.json +1 -1
- package/definitions/blueprint-manifest.json +115 -1
- package/definitions/customer-portal-runtime.json +1 -1
- package/definitions/customer-portal.json +279 -42
- package/definitions/data-management.json +10 -0
- package/definitions/email-template.json +25 -3
- package/definitions/entity.json +205 -3
- package/definitions/erp-integration-runtime.json +1 -1
- package/definitions/erp-integration.json +472 -13
- package/definitions/journey.json +257 -12
- package/definitions/kanban.json +630 -78
- package/definitions/organization-runtime.json +1 -1
- package/definitions/organization.json +614 -51
- package/definitions/workflow.json +40 -0
- package/dist/README-VG67PX4R.js +7 -0
- package/dist/README-W4B35MRN.cjs +7 -0
- package/dist/_index-AMVZBT2K.cjs +99 -0
- package/dist/_index-S6LFD3ER.js +99 -0
- package/dist/access-token-6BJDZSFE.cjs +7 -0
- package/dist/access-token-GSQZLDXR.js +7 -0
- package/dist/address-HA4RMRNQ.cjs +7 -0
- package/dist/address-QVJUGMOG.js +7 -0
- package/dist/address-suggestions-74244BAJ.js +7 -0
- package/dist/address-suggestions-IUQMYF27.cjs +7 -0
- package/dist/ai-agents-IZWFEUSH.js +7 -0
- package/dist/ai-agents-PWHKNRCX.cjs +7 -0
- package/dist/apis/access-token.cjs +10 -13
- package/dist/apis/access-token.js +7 -10
- package/dist/apis/address-suggestions.cjs +10 -13
- package/dist/apis/address-suggestions.js +7 -10
- package/dist/apis/address.cjs +10 -13
- package/dist/apis/address.js +7 -10
- package/dist/apis/ai-agents.cjs +10 -13
- package/dist/apis/ai-agents.js +7 -10
- package/dist/apis/app.cjs +10 -13
- package/dist/apis/app.js +7 -10
- package/dist/apis/audit-logs.cjs +10 -13
- package/dist/apis/audit-logs.js +7 -10
- package/dist/apis/automation.cjs +10 -13
- package/dist/apis/automation.js +7 -10
- package/dist/apis/billing.cjs +10 -13
- package/dist/apis/billing.js +7 -10
- package/dist/apis/blueprint-manifest.cjs +10 -13
- package/dist/apis/blueprint-manifest.js +7 -10
- package/dist/apis/consent.cjs +10 -13
- package/dist/apis/consent.js +7 -10
- package/dist/apis/customer-portal.cjs +10 -13
- package/dist/apis/customer-portal.js +7 -10
- package/dist/apis/dashboard.cjs +10 -13
- package/dist/apis/dashboard.js +7 -10
- package/dist/apis/data-management.cjs +10 -13
- package/dist/apis/data-management.js +7 -10
- package/dist/apis/deduplication.cjs +10 -13
- package/dist/apis/deduplication.js +7 -10
- package/dist/apis/design.cjs +10 -13
- package/dist/apis/design.js +7 -10
- package/dist/apis/document.cjs +10 -13
- package/dist/apis/document.js +7 -10
- package/dist/apis/email-settings.cjs +10 -13
- package/dist/apis/email-settings.js +7 -10
- package/dist/apis/email-template.cjs +10 -13
- package/dist/apis/email-template.js +7 -10
- package/dist/apis/entity-mapping.cjs +10 -13
- package/dist/apis/entity-mapping.js +7 -10
- package/dist/apis/entity.cjs +10 -13
- package/dist/apis/entity.js +7 -10
- package/dist/apis/environments.cjs +10 -13
- package/dist/apis/environments.js +7 -10
- package/dist/apis/erp-integration.cjs +10 -13
- package/dist/apis/erp-integration.js +7 -10
- package/dist/apis/event-catalog.cjs +10 -13
- package/dist/apis/event-catalog.js +7 -10
- package/dist/apis/file.cjs +10 -13
- package/dist/apis/file.js +7 -10
- package/dist/apis/iban.cjs +10 -13
- package/dist/apis/iban.js +7 -10
- package/dist/apis/journey.cjs +10 -13
- package/dist/apis/journey.js +7 -10
- package/dist/apis/kanban.cjs +10 -13
- package/dist/apis/kanban.js +7 -10
- package/dist/apis/message.cjs +10 -13
- package/dist/apis/message.js +7 -10
- package/dist/apis/metering.cjs +10 -13
- package/dist/apis/metering.js +7 -10
- package/dist/apis/notes.cjs +10 -13
- package/dist/apis/notes.js +7 -10
- package/dist/apis/notification.cjs +10 -13
- package/dist/apis/notification.js +7 -10
- package/dist/apis/organization.cjs +10 -13
- package/dist/apis/organization.d.cts +2 -2
- package/dist/apis/organization.d.ts +2 -2
- package/dist/apis/organization.js +7 -10
- package/dist/apis/partner-directory.cjs +10 -13
- package/dist/apis/partner-directory.js +7 -10
- package/dist/apis/permissions.cjs +10 -13
- package/dist/apis/permissions.js +7 -10
- package/dist/apis/pricing-tier.cjs +10 -13
- package/dist/apis/pricing-tier.js +7 -10
- package/dist/apis/pricing.cjs +10 -13
- package/dist/apis/pricing.js +7 -10
- package/dist/apis/purpose.cjs +10 -13
- package/dist/apis/purpose.js +7 -10
- package/dist/apis/sandbox.cjs +10 -13
- package/dist/apis/sandbox.js +7 -10
- package/dist/apis/submission.cjs +10 -13
- package/dist/apis/submission.js +7 -10
- package/dist/apis/targeting.cjs +10 -13
- package/dist/apis/targeting.js +7 -10
- package/dist/apis/template-variables.cjs +10 -13
- package/dist/apis/template-variables.js +7 -10
- package/dist/apis/user.cjs +10 -13
- package/dist/apis/user.js +7 -10
- package/dist/apis/validation-rules.cjs +10 -13
- package/dist/apis/validation-rules.js +7 -10
- package/dist/apis/webhooks.cjs +10 -13
- package/dist/apis/webhooks.js +7 -10
- package/dist/apis/workflow-definition.cjs +10 -13
- package/dist/apis/workflow-definition.js +7 -10
- package/dist/apis/workflow.cjs +10 -13
- package/dist/apis/workflow.js +7 -10
- package/dist/app-IKHWU222.cjs +7 -0
- package/dist/app-VLM3SWKA.js +7 -0
- package/dist/audit-logs-5VXHOQ7S.js +7 -0
- package/dist/audit-logs-D2LFUA2R.cjs +7 -0
- package/dist/automation-3HGCK725.cjs +7 -0
- package/dist/automation-72VGEJCY.js +7 -0
- package/dist/billing-DUWDISHP.cjs +7 -0
- package/dist/billing-IPALEAG2.js +7 -0
- package/dist/blueprint-manifest-CXSCRQ5X.js +7 -0
- package/dist/blueprint-manifest-SHNZPK5O.cjs +7 -0
- package/dist/chunk-2HOJWFQ4.js +14 -0
- package/dist/chunk-372VUPHN.js +14 -0
- package/dist/chunk-3HJEWWPS.cjs +14 -0
- package/dist/chunk-3N67SSL3.js +14 -0
- package/dist/chunk-3XEP56SV.cjs +204 -0
- package/dist/chunk-3ZZ57K3S.cjs +14 -0
- package/dist/chunk-4SWC43JO.cjs +14 -0
- package/dist/chunk-4VFQTSJQ.js +14 -0
- package/dist/chunk-57QIBYDN.js +14 -0
- package/dist/chunk-5SNJAD6F.cjs +14 -0
- package/dist/chunk-73H6TVKN.js +14 -0
- package/dist/chunk-A6JOROUC.cjs +14 -0
- package/dist/chunk-AJKH25H2.cjs +14 -0
- package/dist/chunk-ARWMTXJV.cjs +14 -0
- package/dist/chunk-B3ZGAG7B.js +14 -0
- package/dist/chunk-BH5ZXK4J.cjs +14 -0
- package/dist/chunk-BWFXLUK5.cjs +14 -0
- package/dist/chunk-C6UTZEHH.js +14 -0
- package/dist/chunk-CPKBR34V.js +14 -0
- package/dist/chunk-CWSHYFVZ.js +14 -0
- package/dist/chunk-DJKSULPK.js +14 -0
- package/dist/chunk-DNJ54L2G.js +14 -0
- package/dist/chunk-DY2D2IW5.cjs +14 -0
- package/dist/chunk-E26ZO7QM.cjs +14 -0
- package/dist/chunk-EBCHCYUO.js +14 -0
- package/dist/chunk-EPAIOB5U.cjs +14 -0
- package/dist/chunk-EQZMT2HF.cjs +14 -0
- package/dist/chunk-F376L6PP.cjs +14 -0
- package/dist/chunk-F472YLJG.cjs +14 -0
- package/dist/chunk-FXOX3X7E.cjs +14 -0
- package/dist/chunk-G2REP2VZ.cjs +14 -0
- package/dist/chunk-GLO477NZ.js +14 -0
- package/dist/chunk-H4VSK4KF.js +14 -0
- package/dist/chunk-HPSGM6QP.js +14 -0
- package/dist/chunk-HPYHWTTA.cjs +14 -0
- package/dist/chunk-IH4CMOML.js +14 -0
- package/dist/chunk-IMT3IE5M.cjs +14 -0
- package/dist/chunk-IP2WWEOU.js +14 -0
- package/dist/chunk-IS2VB342.js +14 -0
- package/dist/chunk-ITX53XAZ.js +14 -0
- package/dist/chunk-JXBXDTFG.cjs +14 -0
- package/dist/chunk-K62XK7KU.js +14 -0
- package/dist/chunk-KA3TGFJP.js +14 -0
- package/dist/chunk-KBOVBUBM.js +14 -0
- package/dist/chunk-KPGC2D6E.js +14 -0
- package/dist/chunk-KSXTBGIV.js +14 -0
- package/dist/chunk-LCIJ4TJ4.cjs +14 -0
- package/dist/chunk-LQOLYXGQ.cjs +14 -0
- package/dist/chunk-LSIWCIQV.js +14 -0
- package/dist/chunk-MHNSZ4HE.js +14 -0
- package/dist/chunk-MKX4CKAB.cjs +14 -0
- package/dist/chunk-MRTAFRO7.js +14 -0
- package/dist/chunk-MRZ7LGKZ.js +14 -0
- package/dist/chunk-MSASBR2Y.js +14 -0
- package/dist/chunk-NAWLLC3T.cjs +14 -0
- package/dist/chunk-NJK5F5TF.cjs +21 -0
- package/dist/chunk-NLSZVGHK.cjs +14 -0
- package/dist/chunk-O4LRVGOY.js +14 -0
- package/dist/chunk-OG2DMGU6.cjs +14 -0
- package/dist/chunk-OGQKJTXF.js +14 -0
- package/dist/chunk-PETLAONH.js +14 -0
- package/dist/chunk-PVSS2WPM.cjs +14 -0
- package/dist/chunk-PXITFTJA.cjs +14 -0
- package/dist/chunk-QDVPPRWI.cjs +14 -0
- package/dist/chunk-QKERXNJJ.cjs +14 -0
- package/dist/chunk-QLML3IP5.cjs +14 -0
- package/dist/chunk-QVAJ5JP4.js +14 -0
- package/dist/chunk-RD7E4OSJ.cjs +14 -0
- package/dist/chunk-RWSA3LXE.cjs +14 -0
- package/dist/chunk-RXSS67VI.cjs +14 -0
- package/dist/chunk-S3ZNESMC.cjs +14 -0
- package/dist/chunk-S7NDMDRX.js +14 -0
- package/dist/chunk-SK3VYIZ6.cjs +14 -0
- package/dist/chunk-SMGHAG5C.cjs +14 -0
- package/dist/chunk-T46LODOF.js +14 -0
- package/dist/chunk-TIJWJVKZ.js +14 -0
- package/dist/chunk-TLWCYLNA.js +14 -0
- package/dist/chunk-TRJLYZHD.js +14 -0
- package/dist/chunk-UKKJMCNH.js +14 -0
- package/dist/chunk-ULBEEHG4.js +204 -0
- package/dist/chunk-VGTUK3QD.cjs +14 -0
- package/dist/chunk-VQ7R36AC.js +14 -0
- package/dist/chunk-VVQB5W7U.cjs +14 -0
- package/dist/chunk-VVVATFGK.cjs +14 -0
- package/dist/chunk-WMTYO5OX.cjs +14 -0
- package/dist/chunk-WOSSSFXB.js +14 -0
- package/dist/chunk-WOXXNKTE.js +14 -0
- package/dist/chunk-XKI2OAYV.cjs +14 -0
- package/dist/chunk-XR4QF6KQ.cjs +14 -0
- package/dist/chunk-XYHTQ523.cjs +14 -0
- package/dist/chunk-XZYZLSUO.cjs +14 -0
- package/dist/chunk-YPSWSI3M.js +21 -0
- package/dist/chunk-YYBIU5BQ.js +14 -0
- package/dist/chunk-YZA5WZUS.js +14 -0
- package/dist/chunk-Z4LUE424.cjs +14 -0
- package/dist/chunk-ZV6XYUXS.js +14 -0
- package/dist/consent-CS2ZBZX4.cjs +7 -0
- package/dist/consent-NNYHF2N4.js +7 -0
- package/dist/customer-portal-D3SLPAHZ.js +7 -0
- package/dist/customer-portal-UR3GN4VU.cjs +7 -0
- package/dist/dashboard-UHYR5RTY.cjs +7 -0
- package/dist/dashboard-UTPGXFW5.js +7 -0
- package/dist/data-management-QH2IJ5QV.js +7 -0
- package/dist/data-management-TEFRLGSU.cjs +7 -0
- package/dist/deduplication-ECVAZVVA.cjs +7 -0
- package/dist/deduplication-GYIST22B.js +7 -0
- package/dist/design-KUVXMFFK.cjs +7 -0
- package/dist/design-YKBXRW5C.js +7 -0
- package/dist/document-CY2A2OE7.js +7 -0
- package/dist/document-RYQ7MF6U.cjs +7 -0
- package/dist/email-settings-TQ5GGDYG.js +7 -0
- package/dist/email-settings-TQC34GST.cjs +7 -0
- package/dist/email-template-M2VVL4TI.cjs +7 -0
- package/dist/email-template-WYROV3UG.js +7 -0
- package/dist/entity-FA6PZX6S.js +7 -0
- package/dist/entity-IX5NSHPX.cjs +7 -0
- package/dist/entity-mapping-7J3IAGKQ.js +7 -0
- package/dist/entity-mapping-ZNMFCUKK.cjs +7 -0
- package/dist/environments-E3X6NYGX.js +7 -0
- package/dist/environments-P2JS4F5N.cjs +7 -0
- package/dist/erp-integration-EP2XFEH5.js +7 -0
- package/dist/erp-integration-NNV72VFI.cjs +7 -0
- package/dist/event-catalog-C45ISVMP.cjs +7 -0
- package/dist/event-catalog-D7VJ7WRS.js +7 -0
- package/dist/file-UOWBTDIU.cjs +7 -0
- package/dist/file-XSN3NAVZ.js +7 -0
- package/dist/iban-24GHLFDB.cjs +7 -0
- package/dist/iban-LDKYDVQV.js +7 -0
- package/dist/index.cjs +199 -58
- package/dist/index.d.cts +17 -2
- package/dist/index.d.ts +17 -2
- package/dist/index.js +197 -56
- package/dist/journey-7CKX67M7.js +7 -0
- package/dist/journey-EUZ6MVHG.cjs +7 -0
- package/dist/kanban-CHTH2ZSY.cjs +7 -0
- package/dist/kanban-HI6LL5WY.js +7 -0
- package/dist/message-3XZLJR6R.cjs +7 -0
- package/dist/message-ZNMCS5YH.js +7 -0
- package/dist/metering-DZNZPPY6.cjs +7 -0
- package/dist/metering-KOSCPPKB.js +7 -0
- package/dist/notes-3AO5GXIT.js +7 -0
- package/dist/notes-MPWOQC5J.cjs +7 -0
- package/dist/notification-PZOCUYD5.cjs +7 -0
- package/dist/notification-VWDZRSFZ.js +7 -0
- package/dist/organization-RARYYG2E.cjs +7 -0
- package/dist/organization-ZERPH2IH.js +7 -0
- package/dist/{organization.d-Bd2Hmk8v.d.cts → organization.d-DqwnNxMg.d.cts} +34 -7
- package/dist/{organization.d-Bd2Hmk8v.d.ts → organization.d-DqwnNxMg.d.ts} +34 -7
- package/dist/partner-directory-2XMPQWWX.js +7 -0
- package/dist/partner-directory-WHNTKQ5E.cjs +7 -0
- package/dist/permissions-4T3GFNB4.js +7 -0
- package/dist/permissions-FGBIJNN7.cjs +7 -0
- package/dist/pricing-4Z4TOETA.cjs +7 -0
- package/dist/pricing-C65DTZSX.js +7 -0
- package/dist/pricing-tier-NI35WOUP.cjs +7 -0
- package/dist/pricing-tier-VUOFK5Q7.js +7 -0
- package/dist/purpose-AKOEUHZ4.cjs +7 -0
- package/dist/purpose-RBRV3AQZ.js +7 -0
- package/dist/sandbox-2KN4X66E.cjs +7 -0
- package/dist/sandbox-L2SOOGGR.js +7 -0
- package/dist/submission-7BISSPO6.js +7 -0
- package/dist/submission-Q24BU4GS.cjs +7 -0
- package/dist/targeting-EYGYZD6M.cjs +7 -0
- package/dist/targeting-GEJTJN5Z.js +7 -0
- package/dist/template-variables-OAYS2E3G.cjs +1148 -0
- package/dist/template-variables-VKDJJZUT.js +1148 -0
- package/dist/user-EIEOI3OG.js +7 -0
- package/dist/user-NJJ7XVKB.cjs +7 -0
- package/dist/validation-rules-P6F5P73P.js +7 -0
- package/dist/validation-rules-VDU3CIZV.cjs +7 -0
- package/dist/webhooks-I7JWU34X.cjs +7 -0
- package/dist/webhooks-WPLEHVPX.js +7 -0
- package/dist/workflow-3LLURW3H.js +7 -0
- package/dist/workflow-RAGQDYXT.cjs +7 -0
- package/dist/workflow-definition-B6ELOZUR.cjs +7 -0
- package/dist/workflow-definition-D24CRCK2.js +7 -0
- package/docs/access-token.md +440 -0
- package/docs/address-suggestions.md +256 -0
- package/docs/address.md +284 -0
- package/docs/ai-agents.md +1891 -0
- package/docs/app.md +3388 -0
- package/docs/audit-logs.md +242 -0
- package/docs/automation.md +4044 -0
- package/docs/billing.md +783 -0
- package/docs/blueprint-manifest.md +3234 -0
- package/docs/consent.md +213 -0
- package/docs/customer-portal.md +11399 -0
- package/docs/dashboard.md +640 -0
- package/docs/data-management.md +883 -0
- package/docs/deduplication.md +135 -0
- package/docs/design.md +1273 -0
- package/docs/document.md +590 -0
- package/docs/email-settings.md +1544 -0
- package/docs/email-template.md +1197 -0
- package/docs/entity-mapping.md +2864 -0
- package/docs/entity.md +9595 -0
- package/docs/environments.md +259 -0
- package/docs/erp-integration.md +4572 -0
- package/docs/event-catalog.md +835 -0
- package/docs/file.md +1453 -0
- package/docs/iban.md +61 -0
- package/docs/journey.md +2268 -0
- package/docs/kanban.md +882 -0
- package/docs/message.md +2122 -0
- package/docs/metering.md +1431 -0
- package/docs/notes.md +670 -0
- package/docs/notification.md +1207 -0
- package/docs/organization.md +733 -0
- package/docs/partner-directory.md +1197 -0
- package/docs/permissions.md +1047 -0
- package/docs/pricing-tier.md +81 -0
- package/docs/pricing.md +5923 -0
- package/docs/purpose.md +283 -0
- package/docs/sandbox.md +389 -0
- package/docs/submission.md +195 -0
- package/docs/targeting.md +959 -0
- package/docs/template-variables.md +1141 -0
- package/docs/user.md +2555 -0
- package/docs/validation-rules.md +1597 -0
- package/docs/webhooks.md +996 -0
- package/docs/workflow-definition.md +3842 -0
- package/docs/workflow.md +4465 -0
- package/package.json +3 -2
- package/dist/chunk-XE25WERA.js +0 -125
- package/dist/chunk-XEQMAKGA.cjs +0 -125
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
|
|
2
|
+
|
|
3
|
+
// src/docs/webhooks.json
|
|
4
|
+
var webhooks_default = '# Webhooks\n\n- **Base URL:** `https://webhooks.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/webhooks](https://docs.epilot.io/api/webhooks)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.webhooks.getPublicKey(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/webhooks\'\n\nconst webhooksClient = getClient()\nauthorize(webhooksClient, () => \'<token>\')\nconst { data } = await webhooksClient.getPublicKey(...)\n```\n\n## Operations\n\n**webhooks**\n- [`getPublicKey`](#getpublickey)\n- [`getConfiguredEvents`](#getconfiguredevents)\n- [`getConfigs`](#getconfigs)\n- [`createConfig`](#createconfig)\n- [`getConfig`](#getconfig)\n- [`updateConfig`](#updateconfig)\n- [`deleteConfig`](#deleteconfig)\n- [`triggerWebhook`](#triggerwebhook)\n- [`batchReplayEvents`](#batchreplayevents)\n- [`getEventById`](#geteventbyid)\n- [`replayEvent`](#replayevent)\n- [`getWebhookExample`](#getwebhookexample)\n\n**Events**\n- [`getWebhookEventsV2`](#getwebhookeventsv2)\n\n**Schemas**\n- [`PublicKeyResponse`](#publickeyresponse)\n- [`SearchOptions`](#searchoptions)\n- [`EventListResponse`](#eventlistresponse)\n- [`HttpMethod`](#httpmethod)\n- [`AuthType`](#authtype)\n- [`Filter`](#filter)\n- [`Auth`](#auth)\n- [`BasicAuthConfig`](#basicauthconfig)\n- [`OAuthConfig`](#oauthconfig)\n- [`ApiKeyConfig`](#apikeyconfig)\n- [`WebhookConfig`](#webhookconfig)\n- [`EventConfigResp`](#eventconfigresp)\n- [`EventConfigEntry`](#eventconfigentry)\n- [`ErrorResp`](#errorresp)\n- [`TriggerWebhookResp`](#triggerwebhookresp)\n- [`PayloadConfiguration`](#payloadconfiguration)\n- [`CustomHeader`](#customheader)\n- [`CustomOAuthParameter`](#customoauthparameter)\n- [`Metadata`](#metadata)\n- [`ExecutionPayload`](#executionpayload)\n- [`WebhookEvent`](#webhookevent)\n- [`ExampleRequest`](#examplerequest)\n- [`ExampleResponse`](#exampleresponse)\n- [`BatchReplayRequest`](#batchreplayrequest)\n\n### `getPublicKey`\n\nReturns the platform-level Ed25519 public key used to verify\nasymmetric (v1a) webhook signatures. This endpoint is unauthenticated since the public key is not a secret, but the orgId parameter is requ\n\n`GET /v1/webhooks/.well-known/public-key`\n\n```ts\nconst { data } = await client.getPublicKey({\n orgId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "public_key": "-----BEGIN PUBLIC KEY-----\\nMCowBQYDK2VwAyEA...\\n-----END PUBLIC KEY-----\\n",\n "algorithm": "ed25519",\n "issuer": "epilot"\n}\n```\n\n</details>\n\n---\n\n### `getConfiguredEvents`\n\nRetrieve events that can trigger webhooks\n\n`GET /v1/webhooks/configured-events`\n\n```ts\nconst { data } = await client.getConfiguredEvents()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "eventName": "customer_request_created",\n "eventLabel": "Customer Request Created"\n }\n]\n```\n\n</details>\n\n---\n\n### `getConfigs`\n\nSearch Webhook Client Configs\n\n`GET /v1/webhooks/configs`\n\n```ts\nconst { data } = await client.getConfigs({\n eventName: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "eventName": "CustomerRequest_Created",\n "url": "https://my-partner-service.api.com",\n "httpMethod": "POST",\n "enabled": true,\n "auth": {\n "authType": "BASIC",\n "basicAuthConfig": {\n "username": "secretUsername",\n "password": "secret7825@!"\n }\n },\n "filter": {\n "keyToFilter": "customer_request.productId",\n "supportedValues": ["2324245", "5253642"]\n }\n }\n]\n```\n\n</details>\n\n---\n\n### `createConfig`\n\nCreate Webhook Client Config\n\n`POST /v1/webhooks/configs`\n\n```ts\nconst { data } = await client.createConfig(\n null,\n {\n eventName: \'CustomerRequest_Created\',\n url: \'https://my-partner-service.api.com\',\n httpMethod: \'POST\',\n enabled: true,\n auth: {\n authType: \'BASIC\',\n basicAuthConfig: {\n username: \'secretUsername\',\n password: \'secret7825@!\'\n }\n },\n filter: {\n keyToFilter: \'customer_request.productId\',\n supportedValues: [\'2324245\', \'5253642\']\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "eventName": "CustomerRequest_Created",\n "url": "https://my-partner-service.api.com",\n "httpMethod": "POST",\n "enabled": true,\n "auth": {\n "authType": "BASIC",\n "basicAuthConfig": {\n "username": "secretUsername",\n "password": "secret7825@!"\n }\n },\n "filter": {\n "keyToFilter": "customer_request.productId",\n "supportedValues": ["2324245", "5253642"]\n }\n}\n```\n\n</details>\n\n---\n\n### `getConfig`\n\nGet webhook config by id\n\n`GET /v1/webhooks/configs/{configId}`\n\n```ts\nconst { data } = await client.getConfig({\n configId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "eventName": "CustomerRequest_Created",\n "url": "https://my-partner-service.api.com",\n "httpMethod": "POST",\n "enabled": true,\n "auth": {\n "authType": "BASIC",\n "basicAuthConfig": {\n "username": "secretUsername",\n "password": "secret7825@!"\n }\n },\n "filter": {\n "keyToFilter": "customer_request.productId",\n "supportedValues": ["2324245", "5253642"]\n }\n}\n```\n\n</details>\n\n---\n\n### `updateConfig`\n\nUpdate Webhook Client Config\n\n`PUT /v1/webhooks/configs/{configId}`\n\n```ts\nconst { data } = await client.updateConfig(\n {\n configId: \'example\',\n },\n {\n eventName: \'CustomerRequest_Created\',\n url: \'https://my-partner-service.api.com\',\n httpMethod: \'POST\',\n enabled: true,\n auth: {\n authType: \'BASIC\',\n basicAuthConfig: {\n username: \'secretUsername\',\n password: \'secret7825@!\'\n }\n },\n filter: {\n keyToFilter: \'customer_request.productId\',\n supportedValues: [\'2324245\', \'5253642\']\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "eventName": "CustomerRequest_Created",\n "url": "https://my-partner-service.api.com",\n "httpMethod": "POST",\n "enabled": true,\n "auth": {\n "authType": "BASIC",\n "basicAuthConfig": {\n "username": "secretUsername",\n "password": "secret7825@!"\n }\n },\n "filter": {\n "keyToFilter": "customer_request.productId",\n "supportedValues": ["2324245", "5253642"]\n }\n}\n```\n\n</details>\n\n---\n\n### `deleteConfig`\n\nDelete Webhook Client Config\n\n`DELETE /v1/webhooks/configs/{configId}`\n\n```ts\nconst { data } = await client.deleteConfig({\n configId: \'example\',\n})\n```\n\n---\n\n### `triggerWebhook`\n\ntriggers a webhook event either async or sync\n\n`POST /v1/webhooks/configs/{configId}/trigger`\n\n```ts\nconst { data } = await client.triggerWebhook(\n {\n sync: true,\n configId: \'example\',\n },\n {\n metadata: {\n action: \'Manual triggered by user with id 123456\',\n origin: \'string\',\n creation_timestamp: \'string\',\n webhook_id: \'string\',\n webhook_name: \'string\',\n automation_name: \'string\',\n organization_id: \'string\',\n user_id: \'string\',\n correlation_id: \'string\',\n execution_id: \'string\',\n action_id: \'string\'\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "status_code": "string",\n "message": "string",\n "body": {},\n "code": "string",\n "status": "succeeded",\n "start_date": "string",\n "end_date": "string",\n "event_id": "string"\n}\n```\n\n</details>\n\n---\n\n### `batchReplayEvents`\n\nReplay a batch of webhook events\n\n`POST /v1/webhooks/configs/{configId}/events/replay-batch`\n\n```ts\nconst { data } = await client.batchReplayEvents(\n {\n configId: \'example\',\n },\n {\n eventIds: [\'2f1b7cf8-ff55-4359-966f-e56f39a52c94\', \'48c984bf-466b-470b-b743-d07cea168243\']\n },\n)\n```\n\n---\n\n### `getEventById`\n\nGet a webhook event by its id\n\n`GET /v1/webhooks/configs/{configId}/events/{eventId}`\n\n```ts\nconst { data } = await client.getEventById({\n configId: \'example\',\n eventId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "event_id": "string",\n "org_id": "string",\n "webhook_config_id": "string",\n "url": "string",\n "created_at": "2021-04-27T12:01:13.000Z",\n "event_name": "string",\n "http_response": {\n "status_code": 0,\n "message": "string",\n "body": {},\n "code": "string"\n },\n "metadata": {\n "action": "Manual triggered by user with id 123456",\n "origin": "string",\n "creation_timestamp": "string",\n "webhook_id": "string",\n "webhook_name": "string",\n "automation_name": "string",\n "organization_id": "string",\n "user_id": "string",\n "correlation_id": "string",\n "execution_id": "string",\n "action_id": "string"\n },\n "status": "succeeded",\n "http_method": "GET",\n "payload": "string"\n}\n```\n\n</details>\n\n---\n\n### `replayEvent`\n\nReplay a webhook event\n\n`POST /v1/webhooks/configs/{configId}/events/{eventId}/replay`\n\n```ts\nconst { data } = await client.replayEvent({\n configId: \'example\',\n eventId: \'example\',\n})\n```\n\n---\n\n### `getWebhookExample`\n\nGenerate an example payload for a webhook configuration based on trigger type\n\n`POST /v1/webhooks/configs/{configId}/example`\n\n```ts\nconst { data } = await client.getWebhookExample(\n {\n configId: \'example\',\n },\n {\n automation_id: \'automation_123\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "metadata": {\n "action": "Manual triggered by user with id 123456",\n "origin": "string",\n "creation_timestamp": "string",\n "webhook_id": "string",\n "webhook_name": "string",\n "automation_name": "string",\n "organization_id": "string",\n "user_id": "string",\n "correlation_id": "string",\n "execution_id": "string",\n "action_id": "string"\n },\n "entity": {},\n "relations": [\n {}\n ]\n}\n```\n\n</details>\n\n---\n\n### `getWebhookEventsV2`\n\nList webhook events and filter them by status, timestamp, etc.\n\n`POST /v2/webhooks/configs/{configId}/events`\n\n```ts\nconst { data } = await client.getWebhookEventsV2(\n {\n configId: \'example\',\n },\n {\n limit: 25,\n cursor: {\n created_at: \'2025-10-31T12:34:56Z\',\n event_id: \'evt_1234567890abcdef\'\n },\n timestamp: {\n from: \'2025-10-01T00:00:00Z\',\n to: \'2025-10-31T23:59:59Z\'\n },\n event_id: \'evt_1234567890abcdef\',\n status: \'succeeded\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "data": [\n {\n "event_id": "string",\n "org_id": "string",\n "webhook_config_id": "string",\n "url": "string",\n "created_at": "2021-04-27T12:01:13.000Z",\n "event_name": "string",\n "http_response": {\n "status_code": 0,\n "message": "string",\n "body": {},\n "code": "string"\n },\n "metadata": {\n "action": "Manual triggered by user with id 123456",\n "origin": "string",\n "creation_timestamp": "string",\n "webhook_id": "string",\n "webhook_name": "string",\n "automation_name": "string",\n "organization_id": "string",\n "user_id": "string",\n "correlation_id": "string",\n "execution_id": "string",\n "action_id": "string"\n },\n "status": "succeeded",\n "http_method": "GET",\n "payload": "string"\n }\n ],\n "next_cursor": {\n "created_at": "2025-10-31T12:34:56Z",\n "event_id": "evt_1234567890abcdef"\n },\n "has_more": true\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `PublicKeyResponse`\n\n```ts\ntype PublicKeyResponse = {\n public_key: string\n algorithm: string\n issuer?: string\n}\n```\n\n### `SearchOptions`\n\n```ts\ntype SearchOptions = {\n limit?: number\n cursor?: {\n created_at?: string // date-time\n event_id?: string\n }\n timestamp?: {\n from?: string // date-time\n to?: string // date-time\n }\n event_id?: string\n status?: "succeeded" | "failed"\n}\n```\n\n### `EventListResponse`\n\n```ts\ntype EventListResponse = {\n data?: Array<{\n event_id: string\n org_id: string\n webhook_config_id: string\n url?: string\n created_at?: string\n event_name?: string\n http_response?: {\n status_code?: { ... }\n message?: { ... }\n body?: { ... }\n code?: { ... }\n }\n metadata?: {\n action?: { ... }\n origin?: { ... }\n creation_timestamp?: { ... }\n webhook_id?: { ... }\n webhook_name?: { ... }\n automation_name?: { ... }\n organization_id: { ... }\n user_id?: { ... }\n correlation_id?: { ... }\n execution_id?: { ... }\n action_id?: { ... }\n }\n status?: "succeeded" | "failed" | "in_progress"\n http_method?: "GET" | "POST" | "PUT"\n payload?: string\n }>\n next_cursor?: {\n created_at?: string // date-time\n event_id?: string\n }\n has_more?: boolean\n}\n```\n\n### `HttpMethod`\n\n```ts\ntype HttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD"\n```\n\n### `AuthType`\n\n```ts\ntype AuthType = "BASIC" | "OAUTH_CLIENT_CREDENTIALS" | "API_KEY" | "NONE"\n```\n\n### `Filter`\n\n```ts\ntype Filter = {\n keyToFilter: string\n supportedValues: string[]\n}\n```\n\n### `Auth`\n\n```ts\ntype Auth = {\n authType: "BASIC" | "OAUTH_CLIENT_CREDENTIALS" | "API_KEY" | "NONE"\n basicAuthConfig?: {\n username: string\n password?: string\n passwordIsEnvVar?: boolean\n }\n oauthConfig?: {\n clientId: string\n clientSecret?: string\n clientSecretIsEnvVar?: boolean\n endpoint: string\n httpMethod: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD"\n customParameterList?: Array<{\n type: { ... }\n key: { ... }\n value: { ... }\n }>\n }\n apiKeyConfig?: {\n keyName: string\n keyValue?: string\n keyValueIsEnvVar?: boolean\n }\n}\n```\n\n### `BasicAuthConfig`\n\nTo be sent only if authType is BASIC\n\n```ts\ntype BasicAuthConfig = {\n username: string\n password?: string\n passwordIsEnvVar?: boolean\n}\n```\n\n### `OAuthConfig`\n\nTo be sent only if authType is OAUTH_CLIENT_CREDENTIALS\n\n```ts\ntype OAuthConfig = {\n clientId: string\n clientSecret?: string\n clientSecretIsEnvVar?: boolean\n endpoint: string\n httpMethod: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD"\n customParameterList?: Array<{\n type: "body" | "query" | "header"\n key: string\n value: string\n }>\n}\n```\n\n### `ApiKeyConfig`\n\nTo be sent only if authType is API_KEY\n\n```ts\ntype ApiKeyConfig = {\n keyName: string\n keyValue?: string\n keyValueIsEnvVar?: boolean\n}\n```\n\n### `WebhookConfig`\n\n```ts\ntype WebhookConfig = {\n id?: string\n name: string\n eventName: string\n url?: string\n creationTime?: string\n httpMethod?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD"\n enabled?: boolean\n auth?: {\n authType: "BASIC" | "OAUTH_CLIENT_CREDENTIALS" | "API_KEY" | "NONE"\n basicAuthConfig?: {\n username: { ... }\n password?: { ... }\n passwordIsEnvVar?: { ... }\n }\n oauthConfig?: {\n clientId: { ... }\n clientSecret?: { ... }\n clientSecretIsEnvVar?: { ... }\n endpoint: { ... }\n httpMethod: { ... }\n customParameterList?: { ... }\n }\n apiKeyConfig?: {\n keyName: { ... }\n keyValue?: { ... }\n keyValueIsEnvVar?: { ... }\n }\n }\n filter?: {\n keyToFilter: string\n supportedValues: string[]\n }\n payloadConfiguration?: {\n hydrate_entity?: boolean\n include_relations?: boolean\n include_activity?: boolean\n include_changed_attributes?: boolean\n custom_headers?: Record<string, string>\n }\n enableStaticIP?: boolean\n status?: "active" | "inactive" | "incomplete"\n jsonataExpression?: string\n _manifest?: string // uuid[]\n signingSecret?: string\n}\n```\n\n### `EventConfigResp`\n\n```ts\ntype EventConfigResp = Array<{\n eventName?: string\n eventLabel?: string\n}>\n```\n\n### `EventConfigEntry`\n\n```ts\ntype EventConfigEntry = {\n eventName?: string\n eventLabel?: string\n}\n```\n\n### `ErrorResp`\n\n```ts\ntype ErrorResp = {\n message?: string\n}\n```\n\n### `TriggerWebhookResp`\n\n```ts\ntype TriggerWebhookResp = {\n status_code?: string\n message?: string\n body?: object\n code?: string\n status?: "succeeded" | "failed"\n start_date?: string\n end_date?: string\n event_id: string\n}\n```\n\n### `PayloadConfiguration`\n\nConfiguration for the webhook payload\n\n```ts\ntype PayloadConfiguration = {\n hydrate_entity?: boolean\n include_relations?: boolean\n include_activity?: boolean\n include_changed_attributes?: boolean\n custom_headers?: Record<string, string>\n}\n```\n\n### `CustomHeader`\n\nObject representing custom headers as key-value pairs.\n\n```ts\ntype CustomHeader = Record<string, string>\n```\n\n### `CustomOAuthParameter`\n\nCustom key/value pair of either type body, query or header\n\n```ts\ntype CustomOAuthParameter = {\n type: "body" | "query" | "header"\n key: string\n value: string\n}\n```\n\n### `Metadata`\n\nContains the metadata about the configured event\n\n```ts\ntype Metadata = {\n action?: string\n origin?: string\n creation_timestamp?: string\n webhook_id?: string\n webhook_name?: string\n automation_name?: string\n organization_id: string\n user_id?: string\n correlation_id?: string\n execution_id?: string\n action_id?: string\n}\n```\n\n### `ExecutionPayload`\n\nPayload for triggering a webhook\n\n```ts\ntype ExecutionPayload = {\n metadata: {\n action?: string\n origin?: string\n creation_timestamp?: string\n webhook_id?: string\n webhook_name?: string\n automation_name?: string\n organization_id: string\n user_id?: string\n correlation_id?: string\n execution_id?: string\n action_id?: string\n }\n}\n```\n\n### `WebhookEvent`\n\n```ts\ntype WebhookEvent = {\n event_id: string\n org_id: string\n webhook_config_id: string\n url?: string\n created_at?: string\n event_name?: string\n http_response?: {\n status_code?: number\n message?: string\n body?: object\n code?: string\n }\n metadata?: {\n action?: string\n origin?: string\n creation_timestamp?: string\n webhook_id?: string\n webhook_name?: string\n automation_name?: string\n organization_id: string\n user_id?: string\n correlation_id?: string\n execution_id?: string\n action_id?: string\n }\n status?: "succeeded" | "failed" | "in_progress"\n http_method?: "GET" | "POST" | "PUT"\n payload?: string\n}\n```\n\n### `ExampleRequest`\n\n```ts\ntype ExampleRequest = {\n automation_id?: string\n}\n```\n\n### `ExampleResponse`\n\n```ts\ntype ExampleResponse = {\n metadata?: {\n action?: string\n origin?: string\n creation_timestamp?: string\n webhook_id?: string\n webhook_name?: string\n automation_name?: string\n organization_id: string\n user_id?: string\n correlation_id?: string\n execution_id?: string\n action_id?: string\n }\n entity?: Record<string, unknown>\n relations?: Record<string, unknown>[]\n}\n```\n\n### `BatchReplayRequest`\n\n```ts\ntype BatchReplayRequest = {\n eventIds: string[]\n}\n```\n';
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
exports.default = webhooks_default;
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import "./chunk-YPSWSI3M.js";
|
|
2
|
+
|
|
3
|
+
// src/docs/webhooks.json
|
|
4
|
+
var webhooks_default = '# Webhooks\n\n- **Base URL:** `https://webhooks.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/webhooks](https://docs.epilot.io/api/webhooks)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.webhooks.getPublicKey(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/webhooks\'\n\nconst webhooksClient = getClient()\nauthorize(webhooksClient, () => \'<token>\')\nconst { data } = await webhooksClient.getPublicKey(...)\n```\n\n## Operations\n\n**webhooks**\n- [`getPublicKey`](#getpublickey)\n- [`getConfiguredEvents`](#getconfiguredevents)\n- [`getConfigs`](#getconfigs)\n- [`createConfig`](#createconfig)\n- [`getConfig`](#getconfig)\n- [`updateConfig`](#updateconfig)\n- [`deleteConfig`](#deleteconfig)\n- [`triggerWebhook`](#triggerwebhook)\n- [`batchReplayEvents`](#batchreplayevents)\n- [`getEventById`](#geteventbyid)\n- [`replayEvent`](#replayevent)\n- [`getWebhookExample`](#getwebhookexample)\n\n**Events**\n- [`getWebhookEventsV2`](#getwebhookeventsv2)\n\n**Schemas**\n- [`PublicKeyResponse`](#publickeyresponse)\n- [`SearchOptions`](#searchoptions)\n- [`EventListResponse`](#eventlistresponse)\n- [`HttpMethod`](#httpmethod)\n- [`AuthType`](#authtype)\n- [`Filter`](#filter)\n- [`Auth`](#auth)\n- [`BasicAuthConfig`](#basicauthconfig)\n- [`OAuthConfig`](#oauthconfig)\n- [`ApiKeyConfig`](#apikeyconfig)\n- [`WebhookConfig`](#webhookconfig)\n- [`EventConfigResp`](#eventconfigresp)\n- [`EventConfigEntry`](#eventconfigentry)\n- [`ErrorResp`](#errorresp)\n- [`TriggerWebhookResp`](#triggerwebhookresp)\n- [`PayloadConfiguration`](#payloadconfiguration)\n- [`CustomHeader`](#customheader)\n- [`CustomOAuthParameter`](#customoauthparameter)\n- [`Metadata`](#metadata)\n- [`ExecutionPayload`](#executionpayload)\n- [`WebhookEvent`](#webhookevent)\n- [`ExampleRequest`](#examplerequest)\n- [`ExampleResponse`](#exampleresponse)\n- [`BatchReplayRequest`](#batchreplayrequest)\n\n### `getPublicKey`\n\nReturns the platform-level Ed25519 public key used to verify\nasymmetric (v1a) webhook signatures. This endpoint is unauthenticated since the public key is not a secret, but the orgId parameter is requ\n\n`GET /v1/webhooks/.well-known/public-key`\n\n```ts\nconst { data } = await client.getPublicKey({\n orgId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "public_key": "-----BEGIN PUBLIC KEY-----\\nMCowBQYDK2VwAyEA...\\n-----END PUBLIC KEY-----\\n",\n "algorithm": "ed25519",\n "issuer": "epilot"\n}\n```\n\n</details>\n\n---\n\n### `getConfiguredEvents`\n\nRetrieve events that can trigger webhooks\n\n`GET /v1/webhooks/configured-events`\n\n```ts\nconst { data } = await client.getConfiguredEvents()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "eventName": "customer_request_created",\n "eventLabel": "Customer Request Created"\n }\n]\n```\n\n</details>\n\n---\n\n### `getConfigs`\n\nSearch Webhook Client Configs\n\n`GET /v1/webhooks/configs`\n\n```ts\nconst { data } = await client.getConfigs({\n eventName: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "eventName": "CustomerRequest_Created",\n "url": "https://my-partner-service.api.com",\n "httpMethod": "POST",\n "enabled": true,\n "auth": {\n "authType": "BASIC",\n "basicAuthConfig": {\n "username": "secretUsername",\n "password": "secret7825@!"\n }\n },\n "filter": {\n "keyToFilter": "customer_request.productId",\n "supportedValues": ["2324245", "5253642"]\n }\n }\n]\n```\n\n</details>\n\n---\n\n### `createConfig`\n\nCreate Webhook Client Config\n\n`POST /v1/webhooks/configs`\n\n```ts\nconst { data } = await client.createConfig(\n null,\n {\n eventName: \'CustomerRequest_Created\',\n url: \'https://my-partner-service.api.com\',\n httpMethod: \'POST\',\n enabled: true,\n auth: {\n authType: \'BASIC\',\n basicAuthConfig: {\n username: \'secretUsername\',\n password: \'secret7825@!\'\n }\n },\n filter: {\n keyToFilter: \'customer_request.productId\',\n supportedValues: [\'2324245\', \'5253642\']\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "eventName": "CustomerRequest_Created",\n "url": "https://my-partner-service.api.com",\n "httpMethod": "POST",\n "enabled": true,\n "auth": {\n "authType": "BASIC",\n "basicAuthConfig": {\n "username": "secretUsername",\n "password": "secret7825@!"\n }\n },\n "filter": {\n "keyToFilter": "customer_request.productId",\n "supportedValues": ["2324245", "5253642"]\n }\n}\n```\n\n</details>\n\n---\n\n### `getConfig`\n\nGet webhook config by id\n\n`GET /v1/webhooks/configs/{configId}`\n\n```ts\nconst { data } = await client.getConfig({\n configId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "eventName": "CustomerRequest_Created",\n "url": "https://my-partner-service.api.com",\n "httpMethod": "POST",\n "enabled": true,\n "auth": {\n "authType": "BASIC",\n "basicAuthConfig": {\n "username": "secretUsername",\n "password": "secret7825@!"\n }\n },\n "filter": {\n "keyToFilter": "customer_request.productId",\n "supportedValues": ["2324245", "5253642"]\n }\n}\n```\n\n</details>\n\n---\n\n### `updateConfig`\n\nUpdate Webhook Client Config\n\n`PUT /v1/webhooks/configs/{configId}`\n\n```ts\nconst { data } = await client.updateConfig(\n {\n configId: \'example\',\n },\n {\n eventName: \'CustomerRequest_Created\',\n url: \'https://my-partner-service.api.com\',\n httpMethod: \'POST\',\n enabled: true,\n auth: {\n authType: \'BASIC\',\n basicAuthConfig: {\n username: \'secretUsername\',\n password: \'secret7825@!\'\n }\n },\n filter: {\n keyToFilter: \'customer_request.productId\',\n supportedValues: [\'2324245\', \'5253642\']\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "eventName": "CustomerRequest_Created",\n "url": "https://my-partner-service.api.com",\n "httpMethod": "POST",\n "enabled": true,\n "auth": {\n "authType": "BASIC",\n "basicAuthConfig": {\n "username": "secretUsername",\n "password": "secret7825@!"\n }\n },\n "filter": {\n "keyToFilter": "customer_request.productId",\n "supportedValues": ["2324245", "5253642"]\n }\n}\n```\n\n</details>\n\n---\n\n### `deleteConfig`\n\nDelete Webhook Client Config\n\n`DELETE /v1/webhooks/configs/{configId}`\n\n```ts\nconst { data } = await client.deleteConfig({\n configId: \'example\',\n})\n```\n\n---\n\n### `triggerWebhook`\n\ntriggers a webhook event either async or sync\n\n`POST /v1/webhooks/configs/{configId}/trigger`\n\n```ts\nconst { data } = await client.triggerWebhook(\n {\n sync: true,\n configId: \'example\',\n },\n {\n metadata: {\n action: \'Manual triggered by user with id 123456\',\n origin: \'string\',\n creation_timestamp: \'string\',\n webhook_id: \'string\',\n webhook_name: \'string\',\n automation_name: \'string\',\n organization_id: \'string\',\n user_id: \'string\',\n correlation_id: \'string\',\n execution_id: \'string\',\n action_id: \'string\'\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "status_code": "string",\n "message": "string",\n "body": {},\n "code": "string",\n "status": "succeeded",\n "start_date": "string",\n "end_date": "string",\n "event_id": "string"\n}\n```\n\n</details>\n\n---\n\n### `batchReplayEvents`\n\nReplay a batch of webhook events\n\n`POST /v1/webhooks/configs/{configId}/events/replay-batch`\n\n```ts\nconst { data } = await client.batchReplayEvents(\n {\n configId: \'example\',\n },\n {\n eventIds: [\'2f1b7cf8-ff55-4359-966f-e56f39a52c94\', \'48c984bf-466b-470b-b743-d07cea168243\']\n },\n)\n```\n\n---\n\n### `getEventById`\n\nGet a webhook event by its id\n\n`GET /v1/webhooks/configs/{configId}/events/{eventId}`\n\n```ts\nconst { data } = await client.getEventById({\n configId: \'example\',\n eventId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "event_id": "string",\n "org_id": "string",\n "webhook_config_id": "string",\n "url": "string",\n "created_at": "2021-04-27T12:01:13.000Z",\n "event_name": "string",\n "http_response": {\n "status_code": 0,\n "message": "string",\n "body": {},\n "code": "string"\n },\n "metadata": {\n "action": "Manual triggered by user with id 123456",\n "origin": "string",\n "creation_timestamp": "string",\n "webhook_id": "string",\n "webhook_name": "string",\n "automation_name": "string",\n "organization_id": "string",\n "user_id": "string",\n "correlation_id": "string",\n "execution_id": "string",\n "action_id": "string"\n },\n "status": "succeeded",\n "http_method": "GET",\n "payload": "string"\n}\n```\n\n</details>\n\n---\n\n### `replayEvent`\n\nReplay a webhook event\n\n`POST /v1/webhooks/configs/{configId}/events/{eventId}/replay`\n\n```ts\nconst { data } = await client.replayEvent({\n configId: \'example\',\n eventId: \'example\',\n})\n```\n\n---\n\n### `getWebhookExample`\n\nGenerate an example payload for a webhook configuration based on trigger type\n\n`POST /v1/webhooks/configs/{configId}/example`\n\n```ts\nconst { data } = await client.getWebhookExample(\n {\n configId: \'example\',\n },\n {\n automation_id: \'automation_123\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "metadata": {\n "action": "Manual triggered by user with id 123456",\n "origin": "string",\n "creation_timestamp": "string",\n "webhook_id": "string",\n "webhook_name": "string",\n "automation_name": "string",\n "organization_id": "string",\n "user_id": "string",\n "correlation_id": "string",\n "execution_id": "string",\n "action_id": "string"\n },\n "entity": {},\n "relations": [\n {}\n ]\n}\n```\n\n</details>\n\n---\n\n### `getWebhookEventsV2`\n\nList webhook events and filter them by status, timestamp, etc.\n\n`POST /v2/webhooks/configs/{configId}/events`\n\n```ts\nconst { data } = await client.getWebhookEventsV2(\n {\n configId: \'example\',\n },\n {\n limit: 25,\n cursor: {\n created_at: \'2025-10-31T12:34:56Z\',\n event_id: \'evt_1234567890abcdef\'\n },\n timestamp: {\n from: \'2025-10-01T00:00:00Z\',\n to: \'2025-10-31T23:59:59Z\'\n },\n event_id: \'evt_1234567890abcdef\',\n status: \'succeeded\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "data": [\n {\n "event_id": "string",\n "org_id": "string",\n "webhook_config_id": "string",\n "url": "string",\n "created_at": "2021-04-27T12:01:13.000Z",\n "event_name": "string",\n "http_response": {\n "status_code": 0,\n "message": "string",\n "body": {},\n "code": "string"\n },\n "metadata": {\n "action": "Manual triggered by user with id 123456",\n "origin": "string",\n "creation_timestamp": "string",\n "webhook_id": "string",\n "webhook_name": "string",\n "automation_name": "string",\n "organization_id": "string",\n "user_id": "string",\n "correlation_id": "string",\n "execution_id": "string",\n "action_id": "string"\n },\n "status": "succeeded",\n "http_method": "GET",\n "payload": "string"\n }\n ],\n "next_cursor": {\n "created_at": "2025-10-31T12:34:56Z",\n "event_id": "evt_1234567890abcdef"\n },\n "has_more": true\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `PublicKeyResponse`\n\n```ts\ntype PublicKeyResponse = {\n public_key: string\n algorithm: string\n issuer?: string\n}\n```\n\n### `SearchOptions`\n\n```ts\ntype SearchOptions = {\n limit?: number\n cursor?: {\n created_at?: string // date-time\n event_id?: string\n }\n timestamp?: {\n from?: string // date-time\n to?: string // date-time\n }\n event_id?: string\n status?: "succeeded" | "failed"\n}\n```\n\n### `EventListResponse`\n\n```ts\ntype EventListResponse = {\n data?: Array<{\n event_id: string\n org_id: string\n webhook_config_id: string\n url?: string\n created_at?: string\n event_name?: string\n http_response?: {\n status_code?: { ... }\n message?: { ... }\n body?: { ... }\n code?: { ... }\n }\n metadata?: {\n action?: { ... }\n origin?: { ... }\n creation_timestamp?: { ... }\n webhook_id?: { ... }\n webhook_name?: { ... }\n automation_name?: { ... }\n organization_id: { ... }\n user_id?: { ... }\n correlation_id?: { ... }\n execution_id?: { ... }\n action_id?: { ... }\n }\n status?: "succeeded" | "failed" | "in_progress"\n http_method?: "GET" | "POST" | "PUT"\n payload?: string\n }>\n next_cursor?: {\n created_at?: string // date-time\n event_id?: string\n }\n has_more?: boolean\n}\n```\n\n### `HttpMethod`\n\n```ts\ntype HttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD"\n```\n\n### `AuthType`\n\n```ts\ntype AuthType = "BASIC" | "OAUTH_CLIENT_CREDENTIALS" | "API_KEY" | "NONE"\n```\n\n### `Filter`\n\n```ts\ntype Filter = {\n keyToFilter: string\n supportedValues: string[]\n}\n```\n\n### `Auth`\n\n```ts\ntype Auth = {\n authType: "BASIC" | "OAUTH_CLIENT_CREDENTIALS" | "API_KEY" | "NONE"\n basicAuthConfig?: {\n username: string\n password?: string\n passwordIsEnvVar?: boolean\n }\n oauthConfig?: {\n clientId: string\n clientSecret?: string\n clientSecretIsEnvVar?: boolean\n endpoint: string\n httpMethod: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD"\n customParameterList?: Array<{\n type: { ... }\n key: { ... }\n value: { ... }\n }>\n }\n apiKeyConfig?: {\n keyName: string\n keyValue?: string\n keyValueIsEnvVar?: boolean\n }\n}\n```\n\n### `BasicAuthConfig`\n\nTo be sent only if authType is BASIC\n\n```ts\ntype BasicAuthConfig = {\n username: string\n password?: string\n passwordIsEnvVar?: boolean\n}\n```\n\n### `OAuthConfig`\n\nTo be sent only if authType is OAUTH_CLIENT_CREDENTIALS\n\n```ts\ntype OAuthConfig = {\n clientId: string\n clientSecret?: string\n clientSecretIsEnvVar?: boolean\n endpoint: string\n httpMethod: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD"\n customParameterList?: Array<{\n type: "body" | "query" | "header"\n key: string\n value: string\n }>\n}\n```\n\n### `ApiKeyConfig`\n\nTo be sent only if authType is API_KEY\n\n```ts\ntype ApiKeyConfig = {\n keyName: string\n keyValue?: string\n keyValueIsEnvVar?: boolean\n}\n```\n\n### `WebhookConfig`\n\n```ts\ntype WebhookConfig = {\n id?: string\n name: string\n eventName: string\n url?: string\n creationTime?: string\n httpMethod?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD"\n enabled?: boolean\n auth?: {\n authType: "BASIC" | "OAUTH_CLIENT_CREDENTIALS" | "API_KEY" | "NONE"\n basicAuthConfig?: {\n username: { ... }\n password?: { ... }\n passwordIsEnvVar?: { ... }\n }\n oauthConfig?: {\n clientId: { ... }\n clientSecret?: { ... }\n clientSecretIsEnvVar?: { ... }\n endpoint: { ... }\n httpMethod: { ... }\n customParameterList?: { ... }\n }\n apiKeyConfig?: {\n keyName: { ... }\n keyValue?: { ... }\n keyValueIsEnvVar?: { ... }\n }\n }\n filter?: {\n keyToFilter: string\n supportedValues: string[]\n }\n payloadConfiguration?: {\n hydrate_entity?: boolean\n include_relations?: boolean\n include_activity?: boolean\n include_changed_attributes?: boolean\n custom_headers?: Record<string, string>\n }\n enableStaticIP?: boolean\n status?: "active" | "inactive" | "incomplete"\n jsonataExpression?: string\n _manifest?: string // uuid[]\n signingSecret?: string\n}\n```\n\n### `EventConfigResp`\n\n```ts\ntype EventConfigResp = Array<{\n eventName?: string\n eventLabel?: string\n}>\n```\n\n### `EventConfigEntry`\n\n```ts\ntype EventConfigEntry = {\n eventName?: string\n eventLabel?: string\n}\n```\n\n### `ErrorResp`\n\n```ts\ntype ErrorResp = {\n message?: string\n}\n```\n\n### `TriggerWebhookResp`\n\n```ts\ntype TriggerWebhookResp = {\n status_code?: string\n message?: string\n body?: object\n code?: string\n status?: "succeeded" | "failed"\n start_date?: string\n end_date?: string\n event_id: string\n}\n```\n\n### `PayloadConfiguration`\n\nConfiguration for the webhook payload\n\n```ts\ntype PayloadConfiguration = {\n hydrate_entity?: boolean\n include_relations?: boolean\n include_activity?: boolean\n include_changed_attributes?: boolean\n custom_headers?: Record<string, string>\n}\n```\n\n### `CustomHeader`\n\nObject representing custom headers as key-value pairs.\n\n```ts\ntype CustomHeader = Record<string, string>\n```\n\n### `CustomOAuthParameter`\n\nCustom key/value pair of either type body, query or header\n\n```ts\ntype CustomOAuthParameter = {\n type: "body" | "query" | "header"\n key: string\n value: string\n}\n```\n\n### `Metadata`\n\nContains the metadata about the configured event\n\n```ts\ntype Metadata = {\n action?: string\n origin?: string\n creation_timestamp?: string\n webhook_id?: string\n webhook_name?: string\n automation_name?: string\n organization_id: string\n user_id?: string\n correlation_id?: string\n execution_id?: string\n action_id?: string\n}\n```\n\n### `ExecutionPayload`\n\nPayload for triggering a webhook\n\n```ts\ntype ExecutionPayload = {\n metadata: {\n action?: string\n origin?: string\n creation_timestamp?: string\n webhook_id?: string\n webhook_name?: string\n automation_name?: string\n organization_id: string\n user_id?: string\n correlation_id?: string\n execution_id?: string\n action_id?: string\n }\n}\n```\n\n### `WebhookEvent`\n\n```ts\ntype WebhookEvent = {\n event_id: string\n org_id: string\n webhook_config_id: string\n url?: string\n created_at?: string\n event_name?: string\n http_response?: {\n status_code?: number\n message?: string\n body?: object\n code?: string\n }\n metadata?: {\n action?: string\n origin?: string\n creation_timestamp?: string\n webhook_id?: string\n webhook_name?: string\n automation_name?: string\n organization_id: string\n user_id?: string\n correlation_id?: string\n execution_id?: string\n action_id?: string\n }\n status?: "succeeded" | "failed" | "in_progress"\n http_method?: "GET" | "POST" | "PUT"\n payload?: string\n}\n```\n\n### `ExampleRequest`\n\n```ts\ntype ExampleRequest = {\n automation_id?: string\n}\n```\n\n### `ExampleResponse`\n\n```ts\ntype ExampleResponse = {\n metadata?: {\n action?: string\n origin?: string\n creation_timestamp?: string\n webhook_id?: string\n webhook_name?: string\n automation_name?: string\n organization_id: string\n user_id?: string\n correlation_id?: string\n execution_id?: string\n action_id?: string\n }\n entity?: Record<string, unknown>\n relations?: Record<string, unknown>[]\n}\n```\n\n### `BatchReplayRequest`\n\n```ts\ntype BatchReplayRequest = {\n eventIds: string[]\n}\n```\n';
|
|
5
|
+
export {
|
|
6
|
+
webhooks_default as default
|
|
7
|
+
};
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import "./chunk-YPSWSI3M.js";
|
|
2
|
+
|
|
3
|
+
// src/docs/workflow.json
|
|
4
|
+
var workflow_default = '# Workflows Executions\n\n- **Base URL:** `https://workflows-execution.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/workflow](https://docs.epilot.io/api/workflow)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.workflow.getExecutions(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/workflow\'\n\nconst workflowClient = getClient()\nauthorize(workflowClient, () => \'<token>\')\nconst { data } = await workflowClient.getExecutions(...)\n```\n\n## Operations\n\n**Workflow Executions**\n- [`getExecutions`](#getexecutions)\n- [`createExecution`](#createexecution)\n- [`getExecution`](#getexecution)\n- [`updateExecution`](#updateexecution)\n- [`deleteExecution`](#deleteexecution)\n\n**Workflow Steps**\n- [`createStep`](#createstep)\n- [`updateStep`](#updatestep)\n- [`deleteStep`](#deletestep)\n\n**Closing Reasons**\n- [`getClosingReasonExecution`](#getclosingreasonexecution)\n\n**Flows V2**\n- [`startFlowExecution`](#startflowexecution)\n- [`getFlowExecution`](#getflowexecution)\n- [`patchFlowExecution`](#patchflowexecution)\n- [`deleteFlowExecution`](#deleteflowexecution)\n- [`searchFlowExecutions`](#searchflowexecutions)\n- [`patchTask`](#patchtask)\n- [`runTaskAutomation`](#runtaskautomation)\n- [`executeTask`](#executetask)\n- [`patchPhase`](#patchphase)\n- [`addTask`](#addtask)\n- [`cancelTaskSchedule`](#canceltaskschedule)\n\n**Schemas**\n- [`WorkflowExecutionCreateReq`](#workflowexecutioncreatereq)\n- [`WorkflowExecutionUpdateReq`](#workflowexecutionupdatereq)\n- [`ClosingReason`](#closingreason)\n- [`WorkflowContext`](#workflowcontext)\n- [`WorkflowExecutionBase`](#workflowexecutionbase)\n- [`WorkflowExecutionSlim`](#workflowexecutionslim)\n- [`FlowSlim`](#flowslim)\n- [`Flow`](#flow)\n- [`WorkflowExecution`](#workflowexecution)\n- [`WorkflowStatus`](#workflowstatus)\n- [`SectionSimplified`](#sectionsimplified)\n- [`Section`](#section)\n- [`StepId`](#stepid)\n- [`StepSimplified`](#stepsimplified)\n- [`Step`](#step)\n- [`StepExtended`](#stepextended)\n- [`StepStatus`](#stepstatus)\n- [`SectionStatus`](#sectionstatus)\n- [`StepType`](#steptype)\n- [`StepJourney`](#stepjourney)\n- [`AutomationConfig`](#automationconfig)\n- [`ECPDetails`](#ecpdetails)\n- [`StepDescription`](#stepdescription)\n- [`ItemType`](#itemtype)\n- [`TriggerType`](#triggertype)\n- [`CreateStepReq`](#createstepreq)\n- [`UpdateStepReq`](#updatestepreq)\n- [`StepPositionAt`](#steppositionat)\n- [`UpdateStepResp`](#updatestepresp)\n- [`SearchStepsResp`](#searchstepsresp)\n- [`SearchExecutionsReq`](#searchexecutionsreq)\n- [`SearchExecutionsResp`](#searchexecutionsresp)\n- [`LastEvaluatedKey`](#lastevaluatedkey)\n- [`SearchStepsReq`](#searchstepsreq)\n- [`SearchSorting`](#searchsorting)\n- [`SearchPagination`](#searchpagination)\n- [`ExecutionPaginationDynamo`](#executionpaginationdynamo)\n- [`ErrorResp`](#errorresp)\n- [`ClosingReasonResp`](#closingreasonresp)\n- [`PhaseInEntity`](#phaseinentity)\n- [`WorkflowInEntity`](#workflowinentity)\n- [`UpdateEntityAttributes`](#updateentityattributes)\n- [`EntitySync`](#entitysync)\n- [`DynamicDueDate`](#dynamicduedate)\n- [`StepRequirement`](#steprequirement)\n- [`StartFlowReq`](#startflowreq)\n- [`SearchFlowsReq`](#searchflowsreq)\n- [`PatchFlowReq`](#patchflowreq)\n- [`FlowExecution`](#flowexecution)\n- [`FlowClosingReason`](#flowclosingreason)\n- [`FlowTrigger`](#flowtrigger)\n- [`FlowContext`](#flowcontext)\n- [`EntityRef`](#entityref)\n- [`PhaseId`](#phaseid)\n- [`TaskId`](#taskid)\n- [`Task`](#task)\n- [`TaskType`](#tasktype)\n- [`ManualTask`](#manualtask)\n- [`AutomationTask`](#automationtask)\n- [`LoopInfo`](#loopinfo)\n- [`LoopConfig`](#loopconfig)\n- [`TriggerMode`](#triggermode)\n- [`ActionSchedule`](#actionschedule)\n- [`ImmediateSchedule`](#immediateschedule)\n- [`DelayedSchedule`](#delayedschedule)\n- [`RelativeSchedule`](#relativeschedule)\n- [`DecisionTask`](#decisiontask)\n- [`AiAgentTask`](#aiagenttask)\n- [`AgentConfig`](#agentconfig)\n- [`AgentExecutionInfo`](#agentexecutioninfo)\n- [`TaskBase`](#taskbase)\n- [`Phase`](#phase)\n- [`Edge`](#edge)\n- [`AutomationInfo`](#automationinfo)\n- [`AnalyticsInfo`](#analyticsinfo)\n- [`ConditionId`](#conditionid)\n- [`Condition`](#condition)\n- [`Statement`](#statement)\n- [`EvaluationSource`](#evaluationsource)\n- [`Operator`](#operator)\n- [`DueDateConfig`](#duedateconfig)\n- [`TimeUnit`](#timeunit)\n- [`EnableRequirement`](#enablerequirement)\n- [`FlowTemplateId`](#flowtemplateid)\n- [`FlowExecutionId`](#flowexecutionid)\n- [`UserId`](#userid)\n- [`VariableAssignment`](#variableassignment)\n- [`Assignees`](#assignees)\n- [`PatchTaskReq`](#patchtaskreq)\n- [`PatchPhaseReq`](#patchphasereq)\n- [`AddTaskReq`](#addtaskreq)\n\n### `getExecutions`\n\nRetrieve 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.\n\n`GET /v1/workflows/executions`\n\n```ts\nconst { data } = await client.getExecutions({\n context: \'example\',\n schema: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "id": "8gja72h6kas6h",\n "name": "Lead Qualification",\n "trigger": "MANUAL",\n "status": "STARTED",\n "creationTime": "2021-04-27T12:01:13.000Z",\n "lastUpdateTime": "2021-04-27T12:01:13.000Z",\n "dueDate": "2021-04-27T12:01:13.000Z",\n "flow": [\n {\n "id": "sectionId1",\n "definitionId": "section_definition_id_1",\n "name": "Initial Information Gathering",\n "type": "SECTION",\n "steps": [\n {\n "id": "sada5641f3a21",\n "definitionId": "step_definition_id_1",\n "name": "Call client"\n },\n {\n "id": "sada5641f3a22",\n "definitionId": "step_definition_id_2",\n "name": "Check product availability"\n }\n ]\n },\n {\n "id": "firstLevelStepId1",\n "definitionId": "step_definition_id_4",\n "name": "Print and send catalog",\n "type": "STEP"\n }\n ]\n }\n]\n```\n\n</details>\n\n---\n\n### `createExecution`\n\nCreate a Workflow Execution. Start a new workflow execution, based on a workflow definition (template).\n\n`POST /v1/workflows/executions`\n\n```ts\nconst { data } = await client.createExecution(\n null,\n {\n workflowId: \'j3f23fh23uif98\',\n trigger: \'AUTOMATIC\',\n contexts: [\n {\n id: \'3fa3fa86-0907-4642-a57e-0fe30a19874d\',\n schema: \'contact\'\n },\n {\n id: \'3a6d42fa-5070-4723-b90f-41ead4303e33\',\n schema: \'opportunity\'\n }\n ]\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "8gja72h6kas6h",\n "name": "Lead Qualification",\n "trigger": "MANUAL",\n "status": "STARTED",\n "creationTime": "2021-04-27T12:01:13.000Z",\n "lastUpdateTime": "2021-04-27T12:01:13.000Z",\n "dueDate": "2021-04-27T12:01:13.000Z",\n "assignedTo": ["252", "29052"],\n "flow": [\n {\n "id": "sectionId1",\n "name": "Initial Information Gathering",\n "steps": [\n {\n "id": "sada5641f3a21",\n "name": "Call client and confirm address and product",\n "definitionId": "step_definition_id_1",\n "status": "ASSIGNED",\n "assignedTo": ["11"]\n },\n {\n "id": "sada5641f3a22",\n "name": "Check product availability",\n "status": "UNASSIGNED",\n "definitionId": "step_definition_id_2"\n }\n ]\n },\n {\n "id": "firstLevelStepId1",\n "definitionId": "step_definition_id_4",\n "name": "Print and send catalog",\n "status": "SKIPPED",\n "dueDate": "2023-01-15T20:00:00"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getExecution`\n\nGet a full workflow execution, included steps information, by execution id.\n\n`GET /v1/workflows/executions/{executionId}`\n\n```ts\nconst { data } = await client.getExecution({\n executionId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "8gja72h6kas6h",\n "name": "Lead Qualification",\n "trigger": "MANUAL",\n "status": "STARTED",\n "creationTime": "2021-04-27T12:01:13.000Z",\n "lastUpdateTime": "2021-04-27T12:01:13.000Z",\n "dueDate": "2021-04-27T12:01:13.000Z",\n "assignedTo": ["252", "29052"],\n "flow": [\n {\n "id": "sectionId1",\n "name": "Initial Information Gathering",\n "steps": [\n {\n "id": "sada5641f3a21",\n "name": "Call client and confirm address and product",\n "definitionId": "step_definition_id_1",\n "status": "ASSIGNED",\n "assignedTo": ["11"]\n },\n {\n "id": "sada5641f3a22",\n "name": "Check product availability",\n "status": "UNASSIGNED",\n "definitionId": "step_definition_id_2"\n }\n ]\n },\n {\n "id": "firstLevelStepId1",\n "definitionId": "step_definition_id_4",\n "name": "Print and send catalog",\n "status": "SKIPPED",\n "dueDate": "2023-01-15T20:00:00"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `updateExecution`\n\nPatches updates like assignees, status, closingReason for a single Workflow Execution.\n\n`PATCH /v1/workflows/executions/{executionId}`\n\n```ts\nconst { data } = await client.updateExecution(\n {\n executionId: \'example\',\n },\n {\n status: \'STARTED\',\n assignedTo: [\'string\'],\n selectedClosingReasons: [\n {\n id: \'string\',\n title: \'string\'\n }\n ],\n closingReasonDescription: \'string\',\n dueDate: \'string\',\n dynamicDueDate: {\n numberOfUnits: 0,\n timePeriod: \'minutes\',\n actionTypeCondition: \'WORKFLOW_STARTED\',\n stepId: \'string\',\n phaseId: \'string\'\n },\n closedBy: \'string\',\n contexts: [\n {\n id: \'string\',\n title: \'string\',\n schema: \'string\'\n }\n ],\n completedTime: \'string\'\n },\n)\n```\n\n---\n\n### `deleteExecution`\n\nDelete workflow execution by id. Workflow contexts will NOT be deleted.\n\n`DELETE /v1/workflows/executions/{executionId}`\n\n```ts\nconst { data } = await client.deleteExecution({\n executionId: \'example\',\n})\n```\n\n---\n\n### `createStep`\n\nCreate a new step in current workflow execution.\n\n`POST /v1/workflows/executions/{executionId}/steps`\n\n```ts\nconst { data } = await client.createStep(\n {\n executionId: \'example\',\n },\n {\n insertionIndex: 0,\n name: \'string\',\n description: {\n enabled: true,\n value: \'string\'\n },\n status: \'UNASSIGNED\',\n sectionId: \'string\',\n executionType: \'MANUAL\',\n automationConfig: {\n flowId: \'string\',\n executionId: \'string\',\n executionStatus: \'string\'\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "definitionId": "string",\n "entityRefId": "string",\n "name": "string",\n "description": {\n "enabled": true,\n "value": "string"\n },\n "type": "STEP",\n "ecp": {\n "enabled": true,\n "label": "string",\n "description": "string",\n "journey": {\n "id": "string",\n "journeyId": "string",\n "name": "string",\n "complete_task_automatically": true\n }\n },\n "installer": {\n "enabled": true,\n "label": "string",\n "description": "string",\n "journey": {\n "id": "string",\n "journeyId": "string",\n "name": "string",\n "complete_task_automatically": true\n }\n },\n "enabled": true,\n "requirements": [\n {\n "definitionId": "string",\n "type": "STEP",\n "condition": "CLOSED"\n }\n ],\n "executionType": "MANUAL",\n "sectionId": "string",\n "executionId": "string",\n "userIds": [0],\n "assignedTo": ["string"],\n "assignedToInProgress": "string",\n "assignedToOnHold": "string",\n "status": "UNASSIGNED",\n "created": "string",\n "lastUpdated": "string",\n "statusLastUpdated": "string",\n "startedTime": "string",\n "completedTime": "string",\n "dueDate": "string",\n "dynamicDueDate": {\n "numberOfUnits": 0,\n "timePeriod": "minutes",\n "actionTypeCondition": "WORKFLOW_STARTED",\n "stepId": "string",\n "phaseId": "string"\n },\n "manuallyCreated": true,\n "automationConfig": {\n "flowId": "string",\n "executionId": "string",\n "executionStatus": "string"\n },\n "journey": {\n "id": "string",\n "journeyId": "string",\n "name": "string",\n "complete_task_automatically": true\n },\n "taxonomies": ["string"]\n}\n```\n\n</details>\n\n---\n\n### `updateStep`\n\nPatches various changes to a workflow execution step.\n\n`PATCH /v1/workflows/executions/{executionId}/steps/{stepId}`\n\n```ts\nconst { data } = await client.updateStep(\n {\n executionId: \'example\',\n stepId: \'example\',\n },\n {\n stepId: \'string\',\n entityRefId: \'string\',\n userIds: [0],\n assignedTo: [\'string\'],\n assignedToInProgress: \'string\',\n assignedToOnHold: \'string\',\n status: \'UNASSIGNED\',\n dueDate: \'string\',\n dynamicDueDate: {\n numberOfUnits: 0,\n timePeriod: \'minutes\',\n actionTypeCondition: \'WORKFLOW_STARTED\',\n stepId: \'string\',\n phaseId: \'string\'\n },\n name: \'string\',\n description: {\n enabled: true,\n value: \'string\'\n },\n position: {\n index: 0,\n sectionId: \'string\'\n },\n automationConfig: {\n flowId: \'string\',\n executionId: \'string\',\n executionStatus: \'string\'\n },\n startedTime: \'string\',\n completedTime: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "definitionId": "string",\n "entityRefId": "string",\n "name": "string",\n "description": {\n "enabled": true,\n "value": "string"\n },\n "type": "STEP",\n "ecp": {\n "enabled": true,\n "label": "string",\n "description": "string",\n "journey": {\n "id": "string",\n "journeyId": "string",\n "name": "string",\n "complete_task_automatically": true\n }\n },\n "installer": {\n "enabled": true,\n "label": "string",\n "description": "string",\n "journey": {\n "id": "string",\n "journeyId": "string",\n "name": "string",\n "complete_task_automatically": true\n }\n },\n "enabled": true,\n "requirements": [\n {\n "definitionId": "string",\n "type": "STEP",\n "condition": "CLOSED"\n }\n ],\n "executionType": "MANUAL",\n "sectionId": "string",\n "executionId": "string",\n "userIds": [0],\n "assignedTo": ["string"],\n "assignedToInProgress": "string",\n "assignedToOnHold": "string",\n "status": "UNASSIGNED",\n "created": "string",\n "lastUpdated": "string",\n "statusLastUpdated": "string",\n "startedTime": "string",\n "completedTime": "string",\n "dueDate": "string",\n "dynamicDueDate": {\n "numberOfUnits": 0,\n "timePeriod": "minutes",\n "actionTypeCondition": "WORKFLOW_STARTED",\n "stepId": "string",\n "phaseId": "string"\n },\n "manuallyCreated": true,\n "automationConfig": {\n "flowId": "string",\n "executionId": "string",\n "executionStatus": "string"\n },\n "journey": {\n "id": "string",\n "journeyId": "string",\n "name": "string",\n "complete_task_automatically": true\n },\n "taxonomies": ["string"]\n}\n```\n\n</details>\n\n---\n\n### `deleteStep`\n\nDeletes a step from a workflow execution.\n\n`DELETE /v1/workflows/executions/{executionId}/steps/{stepId}`\n\n```ts\nconst { data } = await client.deleteStep({\n executionId: \'example\',\n stepId: \'example\',\n})\n```\n\n---\n\n### `getClosingReasonExecution`\n\nShows all Closing Reasons defined at the moment of starting the Workflow Execution.\nThe Closing Reasons shown in the execution are just snapshots\nfrom the state of the Definition when the instance was\n\n`GET /v1/workflows/executions/{executionId}/closing-reasons`\n\n```ts\nconst { data } = await client.getClosingReasonExecution({\n executionId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "reasons": [\n {\n "id": "string",\n "title": "string"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `startFlowExecution`\n\nStarts a new Flow Execution based on a flow template.\n\n`POST /v2/flows/executions`\n\n```ts\nconst { data } = await client.startFlowExecution(\n null,\n {\n flow_template_id: \'string\',\n trigger: {\n type: \'MANUAL\',\n automation_config: {\n flow_id: \'string\',\n execution_id: \'string\',\n execution_status: \'string\',\n error_reason: \'string\'\n }\n },\n contexts: [\n {\n entity_id: \'string\',\n entity_schema: \'string\',\n is_primary: false\n }\n ],\n purposes: [\'string\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "flow_template_id": "string",\n "org_id": "string",\n "name": "string",\n "created_at": "string",\n "updated_at": "string",\n "due_date": "string",\n "due_date_config": {\n "duration": 0,\n "unit": "minutes",\n "type": "WORKFLOW_STARTED",\n "task_id": "string",\n "phase_id": "string"\n },\n "status": "STARTED",\n "assigned_to": ["string"],\n "analytics": {\n "started_at": "string",\n "completed_at": "string",\n "closed_at": "string",\n "started_by": "string",\n "closed_by": "string"\n },\n "contexts": [\n {\n "entity_id": "string",\n "entity_schema": "string",\n "is_primary": false\n }\n ],\n "crt_tasks": [\n {\n "id": "string"\n }\n ],\n "phases": [\n {\n "id": "string",\n "template_id": "string",\n "name": "string",\n "status": "OPEN",\n "updated_at": "string",\n "due_date": "2021-04-27T12:00:00.000Z",\n "due_date_config": {},\n "assigned_to": ["string"],\n "analytics": {},\n "taxonomies": ["string"],\n "loop_config": {}\n }\n ],\n "tasks": [\n {\n "id": "string",\n "template_id": "string",\n "name": "string",\n "description": {},\n "status": "UNASSIGNED",\n "journey": {},\n "due_date": "2021-04-27T12:00:00.000Z",\n "due_date_config": {},\n "requirements": [],\n "assigned_to": ["string"],\n "analytics": {},\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "manually_created": true,\n "enabled": true,\n "ecp": {},\n "installer": {},\n "taxonomies": ["string"],\n "phase_id": "string",\n "task_type": "MANUAL",\n "loop_config": {}\n }\n ],\n "edges": [\n {\n "id": "string",\n "from_id": "string",\n "to_id": "string",\n "condition_id": "abc123",\n "none_met": true\n }\n ],\n "_execution_chain": {\n "parent_execution_id": "string",\n "parent_task_id": "string",\n "depth": 0\n },\n "closing_reason": {\n "selected_reasons": [\n {}\n ],\n "configured_reasons": [\n {}\n ],\n "extra_description": "string"\n },\n "available_in_ecp": true,\n "entity_sync": [\n {\n "trigger": {},\n "target": {},\n "value": {}\n }\n ],\n "taxonomies": ["string"],\n "trigger": {\n "type": "MANUAL",\n "automation_config": {\n "flow_id": "string",\n "execution_id": "string",\n "execution_status": "string",\n "error_reason": "string"\n }\n },\n "singleClosingReasonSelection": true\n}\n```\n\n</details>\n\n---\n\n### `getFlowExecution`\n\nGet a full flow execution, included tasks, phases, edges & analytics.\n\n`GET /v2/flows/executions/{execution_id}`\n\n```ts\nconst { data } = await client.getFlowExecution({\n execution_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "flow_template_id": "string",\n "org_id": "string",\n "name": "string",\n "created_at": "string",\n "updated_at": "string",\n "due_date": "string",\n "due_date_config": {\n "duration": 0,\n "unit": "minutes",\n "type": "WORKFLOW_STARTED",\n "task_id": "string",\n "phase_id": "string"\n },\n "status": "STARTED",\n "assigned_to": ["string"],\n "analytics": {\n "started_at": "string",\n "completed_at": "string",\n "closed_at": "string",\n "started_by": "string",\n "closed_by": "string"\n },\n "contexts": [\n {\n "entity_id": "string",\n "entity_schema": "string",\n "is_primary": false\n }\n ],\n "crt_tasks": [\n {\n "id": "string"\n }\n ],\n "phases": [\n {\n "id": "string",\n "template_id": "string",\n "name": "string",\n "status": "OPEN",\n "updated_at": "string",\n "due_date": "2021-04-27T12:00:00.000Z",\n "due_date_config": {},\n "assigned_to": ["string"],\n "analytics": {},\n "taxonomies": ["string"],\n "loop_config": {}\n }\n ],\n "tasks": [\n {\n "id": "string",\n "template_id": "string",\n "name": "string",\n "description": {},\n "status": "UNASSIGNED",\n "journey": {},\n "due_date": "2021-04-27T12:00:00.000Z",\n "due_date_config": {},\n "requirements": [],\n "assigned_to": ["string"],\n "analytics": {},\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "manually_created": true,\n "enabled": true,\n "ecp": {},\n "installer": {},\n "taxonomies": ["string"],\n "phase_id": "string",\n "task_type": "MANUAL",\n "loop_config": {}\n }\n ],\n "edges": [\n {\n "id": "string",\n "from_id": "string",\n "to_id": "string",\n "condition_id": "abc123",\n "none_met": true\n }\n ],\n "_execution_chain": {\n "parent_execution_id": "string",\n "parent_task_id": "string",\n "depth": 0\n },\n "closing_reason": {\n "selected_reasons": [\n {}\n ],\n "configured_reasons": [\n {}\n ],\n "extra_description": "string"\n },\n "available_in_ecp": true,\n "entity_sync": [\n {\n "trigger": {},\n "target": {},\n "value": {}\n }\n ],\n "taxonomies": ["string"],\n "trigger": {\n "type": "MANUAL",\n "automation_config": {\n "flow_id": "string",\n "execution_id": "string",\n "execution_status": "string",\n "error_reason": "string"\n }\n },\n "singleClosingReasonSelection": true\n}\n```\n\n</details>\n\n---\n\n### `patchFlowExecution`\n\nPatch flow execution with new assignees, status, analytics & other changes.\n\n`PATCH /v2/flows/executions/{execution_id}`\n\n```ts\nconst { data } = await client.patchFlowExecution(\n {\n execution_id: \'example\',\n },\n {\n status: \'STARTED\',\n assigned_to: [\'string\'],\n closing_reason: {\n selected_reasons: [\n {\n id: \'string\',\n title: \'string\'\n }\n ],\n configured_reasons: [\n {\n id: \'string\',\n title: \'string\'\n }\n ],\n extra_description: \'string\'\n },\n due_date: \'string\',\n due_date_config: {\n duration: 0,\n unit: \'minutes\',\n type: \'WORKFLOW_STARTED\',\n task_id: \'string\',\n phase_id: \'string\'\n },\n contexts: [\n {\n entity_id: \'string\',\n entity_schema: \'string\',\n is_primary: false\n }\n ]\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "flow_template_id": "string",\n "org_id": "string",\n "name": "string",\n "created_at": "string",\n "updated_at": "string",\n "due_date": "string",\n "due_date_config": {\n "duration": 0,\n "unit": "minutes",\n "type": "WORKFLOW_STARTED",\n "task_id": "string",\n "phase_id": "string"\n },\n "status": "STARTED",\n "assigned_to": ["string"],\n "analytics": {\n "started_at": "string",\n "completed_at": "string",\n "closed_at": "string",\n "started_by": "string",\n "closed_by": "string"\n },\n "contexts": [\n {\n "entity_id": "string",\n "entity_schema": "string",\n "is_primary": false\n }\n ],\n "crt_tasks": [\n {\n "id": "string"\n }\n ],\n "phases": [\n {\n "id": "string",\n "template_id": "string",\n "name": "string",\n "status": "OPEN",\n "updated_at": "string",\n "due_date": "2021-04-27T12:00:00.000Z",\n "due_date_config": {},\n "assigned_to": ["string"],\n "analytics": {},\n "taxonomies": ["string"],\n "loop_config": {}\n }\n ],\n "tasks": [\n {\n "id": "string",\n "template_id": "string",\n "name": "string",\n "description": {},\n "status": "UNASSIGNED",\n "journey": {},\n "due_date": "2021-04-27T12:00:00.000Z",\n "due_date_config": {},\n "requirements": [],\n "assigned_to": ["string"],\n "analytics": {},\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "manually_created": true,\n "enabled": true,\n "ecp": {},\n "installer": {},\n "taxonomies": ["string"],\n "phase_id": "string",\n "task_type": "MANUAL",\n "loop_config": {}\n }\n ],\n "edges": [\n {\n "id": "string",\n "from_id": "string",\n "to_id": "string",\n "condition_id": "abc123",\n "none_met": true\n }\n ],\n "_execution_chain": {\n "parent_execution_id": "string",\n "parent_task_id": "string",\n "depth": 0\n },\n "closing_reason": {\n "selected_reasons": [\n {}\n ],\n "configured_reasons": [\n {}\n ],\n "extra_description": "string"\n },\n "available_in_ecp": true,\n "entity_sync": [\n {\n "trigger": {},\n "target": {},\n "value": {}\n }\n ],\n "taxonomies": ["string"],\n "trigger": {\n "type": "MANUAL",\n "automation_config": {\n "flow_id": "string",\n "execution_id": "string",\n "execution_status": "string",\n "error_reason": "string"\n }\n },\n "singleClosingReasonSelection": true\n}\n```\n\n</details>\n\n---\n\n### `deleteFlowExecution`\n\nDeletes a specific execution of a flow, identified by id. Flow contexts will NOT be deleted.\n\n`DELETE /v2/flows/executions/{execution_id}`\n\n```ts\nconst { data } = await client.deleteFlowExecution({\n execution_id: \'example\',\n soft: true,\n})\n```\n\n---\n\n### `searchFlowExecutions`\n\nSearch Flow Executions for a specific Entity.\n\n`POST /v2/flows/executions:search`\n\n```ts\nconst { data } = await client.searchFlowExecutions(\n null,\n {\n entity_id: \'string\',\n entity_schema: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "id": "string",\n "flow_template_id": "string",\n "org_id": "string",\n "name": "string",\n "created_at": "string",\n "updated_at": "string",\n "due_date": "string",\n "due_date_config": {},\n "status": "STARTED",\n "assigned_to": ["string"],\n "analytics": {},\n "contexts": [],\n "crt_tasks": [],\n "phases": [],\n "tasks": [],\n "edges": [],\n "_execution_chain": {},\n "closing_reason": {},\n "available_in_ecp": true,\n "entity_sync": [],\n "taxonomies": ["string"],\n "trigger": {},\n "singleClosingReasonSelection": true\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `patchTask`\n\nChanges various attributes of a flow task, like assignees, status, due date, etc.\n\n`PATCH /v2/flows/executions/{execution_id}/tasks/{task_id}`\n\n```ts\nconst { data } = await client.patchTask(\n {\n execution_id: \'example\',\n task_id: \'example\',\n },\n {\n name: \'string\',\n status: \'UNASSIGNED\',\n due_date: \'2021-04-27T12:00:00.000Z\',\n due_date_config: {\n duration: 0,\n unit: \'minutes\',\n type: \'WORKFLOW_STARTED\',\n task_id: \'string\',\n phase_id: \'string\'\n },\n assigned_to: [\'string\'],\n enabled: true,\n automation_config: {\n flow_id: \'string\',\n execution_id: \'string\',\n execution_status: \'string\',\n error_reason: \'string\'\n },\n description: {\n enabled: true,\n value: \'string\'\n },\n ecp: {\n enabled: true,\n label: \'string\',\n description: \'string\',\n journey: {\n id: \'string\',\n journeyId: \'string\',\n name: \'string\',\n complete_task_automatically: true\n }\n },\n installer: {\n enabled: true,\n label: \'string\',\n description: \'string\',\n journey: {\n id: \'string\',\n journeyId: \'string\',\n name: \'string\',\n complete_task_automatically: true\n }\n },\n next_condition_id: \'string\',\n revert_execution: false\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "template_id": "string",\n "name": "string",\n "description": {\n "enabled": true,\n "value": "string"\n },\n "status": "UNASSIGNED",\n "journey": {\n "id": "string",\n "journeyId": "string",\n "name": "string",\n "complete_task_automatically": true\n },\n "due_date": "2021-04-27T12:00:00.000Z",\n "due_date_config": {\n "duration": 0,\n "unit": "minutes",\n "type": "WORKFLOW_STARTED",\n "task_id": "string",\n "phase_id": "string"\n },\n "requirements": [\n {\n "task_id": "string",\n "phase_id": "string",\n "when": "TASK_FINISHED"\n }\n ],\n "assigned_to": ["string"],\n "analytics": {\n "started_at": "1970-01-01T00:00:00.000Z",\n "in_progress_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "status_updated_at": "1970-01-01T00:00:00.000Z",\n "in_progress_by": "string",\n "completed_by": "string",\n "skipped_by": "string",\n "on_hold_by": "string"\n },\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "manually_created": true,\n "enabled": true,\n "ecp": {\n "enabled": true,\n "label": "string",\n "description": "string",\n "journey": {\n "id": "string",\n "journeyId": "string",\n "name": "string",\n "complete_task_automatically": true\n }\n },\n "installer": {\n "enabled": true,\n "label": "string",\n "description": "string",\n "journey": {\n "id": "string",\n "journeyId": "string",\n "name": "string",\n "complete_task_automatically": true\n }\n },\n "taxonomies": ["string"],\n "phase_id": "string",\n "task_type": "MANUAL",\n "loop_config": {\n "max_iterations": 3,\n "crt_iterations": 0\n }\n}\n```\n\n</details>\n\n---\n\n### `runTaskAutomation`\n\nRuns configured automation for a flow task\n\n`POST /v2/flows/executions/{execution_id}/tasks/{task_id}/automation:run`\n\n```ts\nconst { data } = await client.runTaskAutomation({\n execution_id: \'example\',\n task_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "template_id": "string",\n "name": "string",\n "description": {\n "enabled": true,\n "value": "string"\n },\n "status": "UNASSIGNED",\n "journey": {\n "id": "string",\n "journeyId": "string",\n "name": "string",\n "complete_task_automatically": true\n },\n "due_date": "2021-04-27T12:00:00.000Z",\n "due_date_config": {\n "duration": 0,\n "unit": "minutes",\n "type": "WORKFLOW_STARTED",\n "task_id": "string",\n "phase_id": "string"\n },\n "requirements": [\n {\n "task_id": "string",\n "phase_id": "string",\n "when": "TASK_FINISHED"\n }\n ],\n "assigned_to": ["string"],\n "analytics": {\n "started_at": "1970-01-01T00:00:00.000Z",\n "in_progress_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "status_updated_at": "1970-01-01T00:00:00.000Z",\n "in_progress_by": "string",\n "completed_by": "string",\n "skipped_by": "string",\n "on_hold_by": "string"\n },\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "manually_created": true,\n "enabled": true,\n "ecp": {\n "enabled": true,\n "label": "string",\n "description": "string",\n "journey": {\n "id": "string",\n "journeyId": "string",\n "name": "string",\n "complete_task_automatically": true\n }\n },\n "installer": {\n "enabled": true,\n "label": "string",\n "description": "string",\n "journey": {\n "id": "string",\n "journeyId": "string",\n "name": "string",\n "complete_task_automatically": true\n }\n },\n "taxonomies": ["string"],\n "phase_id": "string",\n "task_type": "MANUAL",\n "automation_config": {\n "flow_id": "string",\n "execution_id": "string",\n "execution_status": "string",\n "error_reason": "string"\n },\n "automation_execution_id": "string",\n "trigger_mode": "manual",\n "schedule": {\n "mode": "immediate"\n },\n "loop_config": {\n "max_iterations": 3,\n "crt_iterations": 0\n }\n}\n```\n\n</details>\n\n---\n\n### `executeTask`\n\nExecutes any kind of flow task immediately.\n\n`POST /v2/flows/executions/{execution_id}/tasks/{task_id}/execute`\n\n```ts\nconst { data } = await client.executeTask({\n execution_id: \'example\',\n task_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "template_id": "string",\n "name": "string",\n "description": {\n "enabled": true,\n "value": "string"\n },\n "status": "UNASSIGNED",\n "journey": {\n "id": "string",\n "journeyId": "string",\n "name": "string",\n "complete_task_automatically": true\n },\n "due_date": "2021-04-27T12:00:00.000Z",\n "due_date_config": {\n "duration": 0,\n "unit": "minutes",\n "type": "WORKFLOW_STARTED",\n "task_id": "string",\n "phase_id": "string"\n },\n "requirements": [\n {\n "task_id": "string",\n "phase_id": "string",\n "when": "TASK_FINISHED"\n }\n ],\n "assigned_to": ["string"],\n "analytics": {\n "started_at": "1970-01-01T00:00:00.000Z",\n "in_progress_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "status_updated_at": "1970-01-01T00:00:00.000Z",\n "in_progress_by": "string",\n "completed_by": "string",\n "skipped_by": "string",\n "on_hold_by": "string"\n },\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "manually_created": true,\n "enabled": true,\n "ecp": {\n "enabled": true,\n "label": "string",\n "description": "string",\n "journey": {\n "id": "string",\n "journeyId": "string",\n "name": "string",\n "complete_task_automatically": true\n }\n },\n "installer": {\n "enabled": true,\n "label": "string",\n "description": "string",\n "journey": {\n "id": "string",\n "journeyId": "string",\n "name": "string",\n "complete_task_automatically": true\n }\n },\n "taxonomies": ["string"],\n "phase_id": "string",\n "task_type": "MANUAL",\n "loop_config": {\n "max_iterations": 3,\n "crt_iterations": 0\n }\n}\n```\n\n</details>\n\n---\n\n### `patchPhase`\n\nApply updates to a phase within flow execution\n\n`PATCH /v2/flows/executions/{execution_id}/phases/{phase_id}`\n\n```ts\nconst { data } = await client.patchPhase(\n {\n execution_id: \'example\',\n phase_id: \'example\',\n },\n {\n name: \'string\',\n due_date: \'2021-04-27T12:00:00.000Z\',\n due_date_config: {\n duration: 0,\n unit: \'minutes\',\n type: \'WORKFLOW_STARTED\',\n task_id: \'string\',\n phase_id: \'string\'\n },\n assigned_to: [\'string\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "template_id": "string",\n "name": "string",\n "status": "OPEN",\n "updated_at": "string",\n "due_date": "2021-04-27T12:00:00.000Z",\n "due_date_config": {\n "duration": 0,\n "unit": "minutes",\n "type": "WORKFLOW_STARTED",\n "task_id": "string",\n "phase_id": "string"\n },\n "assigned_to": ["string"],\n "analytics": {\n "started_at": "1970-01-01T00:00:00.000Z",\n "in_progress_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "status_updated_at": "1970-01-01T00:00:00.000Z",\n "in_progress_by": "string",\n "completed_by": "string",\n "skipped_by": "string",\n "on_hold_by": "string"\n },\n "taxonomies": ["string"],\n "loop_config": {\n "max_iterations": 3,\n "crt_iterations": 0\n }\n}\n```\n\n</details>\n\n---\n\n### `addTask`\n\nCreate a new task in current workflow execution.\n\n`POST /v2/flows/executions/{execution_id}/tasks`\n\n```ts\nconst { data } = await client.addTask(\n {\n execution_id: \'example\',\n },\n {\n previous_task_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n next_task_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n task: {\n id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n name: \'string\',\n status: \'UNASSIGNED\',\n due_date: \'2021-04-27T12:00:00.000Z\',\n due_date_config: {\n duration: 0,\n unit: \'minutes\',\n type: \'WORKFLOW_STARTED\',\n task_id: \'string\',\n phase_id: \'string\'\n },\n assigned_to: [\'string\'],\n enabled: true,\n automation_config: {\n flow_id: \'string\',\n execution_id: \'string\',\n execution_status: \'string\',\n error_reason: \'string\'\n },\n phase_id: \'string\',\n task_type: \'MANUAL\'\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "template_id": "string",\n "name": "string",\n "description": {\n "enabled": true,\n "value": "string"\n },\n "status": "UNASSIGNED",\n "journey": {\n "id": "string",\n "journeyId": "string",\n "name": "string",\n "complete_task_automatically": true\n },\n "due_date": "2021-04-27T12:00:00.000Z",\n "due_date_config": {\n "duration": 0,\n "unit": "minutes",\n "type": "WORKFLOW_STARTED",\n "task_id": "string",\n "phase_id": "string"\n },\n "requirements": [\n {\n "task_id": "string",\n "phase_id": "string",\n "when": "TASK_FINISHED"\n }\n ],\n "assigned_to": ["string"],\n "analytics": {\n "started_at": "1970-01-01T00:00:00.000Z",\n "in_progress_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "status_updated_at": "1970-01-01T00:00:00.000Z",\n "in_progress_by": "string",\n "completed_by": "string",\n "skipped_by": "string",\n "on_hold_by": "string"\n },\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "manually_created": true,\n "enabled": true,\n "ecp": {\n "enabled": true,\n "label": "string",\n "description": "string",\n "journey": {\n "id": "string",\n "journeyId": "string",\n "name": "string",\n "complete_task_automatically": true\n }\n },\n "installer": {\n "enabled": true,\n "label": "string",\n "description": "string",\n "journey": {\n "id": "string",\n "journeyId": "string",\n "name": "string",\n "complete_task_automatically": true\n }\n },\n "taxonomies": ["string"],\n "phase_id": "string",\n "task_type": "MANUAL",\n "loop_config": {\n "max_iterations": 3,\n "crt_iterations": 0\n }\n}\n```\n\n</details>\n\n---\n\n### `cancelTaskSchedule`\n\nCancels a scheduled task, deleting the schedule and marking the task as skipped.\n\n`DELETE /v2/flows/executions/{execution_id}/tasks/{task_id}/schedule`\n\n```ts\nconst { data } = await client.cancelTaskSchedule({\n execution_id: \'example\',\n task_id: \'example\',\n})\n```\n\n---\n\n## Schemas\n\n### `WorkflowExecutionCreateReq`\n\n```ts\ntype WorkflowExecutionCreateReq = {\n workflowId: string\n trigger?: "MANUAL" | "AUTOMATIC"\n assignedTo?: string[]\n contexts?: Array<{\n id: string\n title: string\n schema: string\n }>\n purposes?: string[]\n}\n```\n\n### `WorkflowExecutionUpdateReq`\n\n```ts\ntype WorkflowExecutionUpdateReq = {\n status?: "STARTED" | "DONE" | "CLOSED"\n assignedTo?: string[]\n selectedClosingReasons?: Array<{\n id: string\n title: string\n }>\n closingReasonDescription?: string\n dueDate?: string\n dynamicDueDate?: {\n numberOfUnits: number\n timePeriod: "minutes" | "hours" | "days" | "weeks" | "months"\n actionTypeCondition?: "WORKFLOW_STARTED" | "STEP_CLOSED" | "PHASE_FINISHED"\n stepId?: string\n phaseId?: string\n }\n closedBy?: string\n contexts?: Array<{\n id: string\n title: string\n schema: string\n }>\n completedTime?: string\n}\n```\n\n### `ClosingReason`\n\n```ts\ntype ClosingReason = {\n id: string\n title: string\n}\n```\n\n### `WorkflowContext`\n\n```ts\ntype WorkflowContext = {\n id: string\n title: string\n schema: string\n}\n```\n\n### `WorkflowExecutionBase`\n\n```ts\ntype WorkflowExecutionBase = {\n id?: string\n definitionId?: string\n orgId?: string\n name?: string\n creationTime?: string\n lastUpdateTime?: string\n dueDate?: string\n completedTime?: string\n dynamicDueDate?: {\n numberOfUnits: number\n timePeriod: "minutes" | "hours" | "days" | "weeks" | "months"\n actionTypeCondition?: "WORKFLOW_STARTED" | "STEP_CLOSED" | "PHASE_FINISHED"\n stepId?: string\n phaseId?: string\n }\n status?: "STARTED" | "DONE" | "CLOSED"\n trigger?: "MANUAL" | "AUTOMATIC"\n assignedTo?: string[]\n lastModifiedBy?: string\n contexts?: Array<{\n id: string\n title: string\n schema: string\n }>\n nextOpenStep?: {\n id?: string\n entityRefId?: string\n }\n configuredClosingReasonSnapshot?: Array<{\n id: string\n title: string\n }>\n selectedClosingReasons?: Array<{\n id: string\n title: string\n }>\n closingReasonDescription?: string\n enableECPWorkflow?: boolean\n updateEntityAttributes?: Array<{\n source: "workflow_status" | "current_section" | "current_step"\n target: {\n entitySchema: { ... }\n entityAttribute: { ... }\n }\n }>\n version?: number\n taxonomies?: string[]\n singleClosingReasonSelection?: boolean\n}\n```\n\n### `WorkflowExecutionSlim`\n\n```ts\ntype WorkflowExecutionSlim = {\n id?: string\n definitionId?: string\n orgId?: string\n name?: string\n creationTime?: string\n lastUpdateTime?: string\n dueDate?: string\n completedTime?: string\n dynamicDueDate?: {\n numberOfUnits: number\n timePeriod: "minutes" | "hours" | "days" | "weeks" | "months"\n actionTypeCondition?: "WORKFLOW_STARTED" | "STEP_CLOSED" | "PHASE_FINISHED"\n stepId?: string\n phaseId?: string\n }\n status?: "STARTED" | "DONE" | "CLOSED"\n trigger?: "MANUAL" | "AUTOMATIC"\n assignedTo?: string[]\n lastModifiedBy?: string\n contexts?: Array<{\n id: string\n title: string\n schema: string\n }>\n nextOpenStep?: {\n id?: string\n entityRefId?: string\n }\n configuredClosingReasonSnapshot?: Array<{\n id: string\n title: string\n }>\n selectedClosingReasons?: Array<{\n id: string\n title: string\n }>\n closingReasonDescription?: string\n enableECPWorkflow?: boolean\n updateEntityAttributes?: Array<{\n source: "workflow_status" | "current_section" | "current_step"\n target: {\n entitySchema: { ... }\n entityAttribute: { ... }\n }\n }>\n version?: number\n taxonomies?: string[]\n singleClosingReasonSelection?: boolean\n flow: Array<{\n id: string\n definitionId?: string\n name: string\n userIds?: number[]\n assignedTo?: string[]\n dueDate?: string\n dynamicDueDate?: {\n numberOfUnits: { ... }\n timePeriod: { ... }\n actionTypeCondition?: { ... }\n stepId?: { ... }\n phaseId?: { ... }\n }\n startedTime?: string\n completedTime?: string\n status?: "OPEN" | "IN_PROGRESS" | "COMPLETED"\n type: "STEP" | "SECTION"\n steps: Array<{\n id: { ... }\n definitionId?: { ... }\n entityRefId?: { ... }\n name: { ... }\n description?: { ... }\n type: { ... }\n ecp?: { ... }\n installer?: { ... }\n enabled?: { ... }\n requirements?: { ... }\n executionType?: { ... }\n sectionId?: { ... }\n executionId?: { ... }\n userIds?: { ... }\n assignedTo?: { ... }\n assignedToInProgress?: { ... }\n assignedToOnHold?: { ... }\n status?: { ... }\n created?: { ... }\n lastUpdated?: { ... }\n statusLastUpdated?: { ... }\n startedTime?: { ... }\n completedTime?: { ... }\n dueDate?: { ... }\n dynamicDueDate?: { ... }\n manuallyCreated?: { ... }\n automationConfig?: { ... }\n journey?: { ... }\n taxonomies?: { ... }\n }>\n taxonomies?: string[]\n } | {\n // ...\n}\n```\n\n### `FlowSlim`\n\n```ts\ntype FlowSlim = {\n flow: Array<{\n id: string\n definitionId?: string\n name: string\n userIds?: number[]\n assignedTo?: string[]\n dueDate?: string\n dynamicDueDate?: {\n numberOfUnits: { ... }\n timePeriod: { ... }\n actionTypeCondition?: { ... }\n stepId?: { ... }\n phaseId?: { ... }\n }\n startedTime?: string\n completedTime?: string\n status?: "OPEN" | "IN_PROGRESS" | "COMPLETED"\n type: "STEP" | "SECTION"\n steps: Array<{\n id: { ... }\n definitionId?: { ... }\n entityRefId?: { ... }\n name: { ... }\n description?: { ... }\n type: { ... }\n ecp?: { ... }\n installer?: { ... }\n enabled?: { ... }\n requirements?: { ... }\n executionType?: { ... }\n sectionId?: { ... }\n executionId?: { ... }\n userIds?: { ... }\n assignedTo?: { ... }\n assignedToInProgress?: { ... }\n assignedToOnHold?: { ... }\n status?: { ... }\n created?: { ... }\n lastUpdated?: { ... }\n statusLastUpdated?: { ... }\n startedTime?: { ... }\n completedTime?: { ... }\n dueDate?: { ... }\n dynamicDueDate?: { ... }\n manuallyCreated?: { ... }\n automationConfig?: { ... }\n journey?: { ... }\n taxonomies?: { ... }\n }>\n taxonomies?: string[]\n } | {\n id: string\n definitionId?: string\n entityRefId?: string\n name: string\n description?: {\n enabled?: { ... }\n value?: { ... }\n }\n type: "STEP" | "SECTION"\n ecp?: {\n enabled?: { ... }\n label?: { ... }\n description?: { ... }\n journey?: { ... }\n }\n installer?: {\n enabled?: { ... }\n label?: { ... }\n description?: { ... }\n journey?: { ... }\n }\n enabled?: boolean\n requirements?: Array<{\n definitionId: { ... }\n type: { ... }\n condition: { ... }\n }>\n executionType?: "MANUAL" | "AUTOMATION"\n sectionId?: string\n executionId?: string\n userIds?: number[]\n assignedTo?: string[]\n assignedToInProgress?: string\n assignedToOnHold?: string\n status?: "UNASSIGNED" | "ASSIGNED" | "COMPLETED" | "SKIPPED" | "IN_PROGRESS" | "SCHEDULED" | "PENDING" | "CONDITION_PENDING" | "WAITING_FOR_CONFIRMATION" | "ON_HOLD" | "FAILED"\n created?: string\n lastUpdated?: string\n statusLastUpdated?: string\n startedTime?: string\n completedTime?: string\n dueDate?: string\n dynamicDueDate?: {\n numberOfUnits: { ... }\n timePeriod: { ... }\n actionTypeCondition?: { ... }\n stepId?: { ... }\n phaseId?: { ... }\n }\n // ...\n}\n```\n\n### `Flow`\n\n```ts\ntype Flow = {\n flow: Array<{\n id: string\n definitionId?: string\n name: string\n userIds?: number[]\n assignedTo?: string[]\n dueDate?: string\n dynamicDueDate?: {\n numberOfUnits: { ... }\n timePeriod: { ... }\n actionTypeCondition?: { ... }\n stepId?: { ... }\n phaseId?: { ... }\n }\n startedTime?: string\n completedTime?: string\n status?: "OPEN" | "IN_PROGRESS" | "COMPLETED"\n type: "STEP" | "SECTION"\n steps: Array<{\n id: { ... }\n definitionId?: { ... }\n entityRefId?: { ... }\n name: { ... }\n description?: { ... }\n type: { ... }\n ecp?: { ... }\n installer?: { ... }\n enabled?: { ... }\n requirements?: { ... }\n executionType?: { ... }\n sectionId?: { ... }\n executionId?: { ... }\n userIds?: { ... }\n assignedTo?: { ... }\n assignedToInProgress?: { ... }\n assignedToOnHold?: { ... }\n status?: { ... }\n created?: { ... }\n lastUpdated?: { ... }\n statusLastUpdated?: { ... }\n startedTime?: { ... }\n completedTime?: { ... }\n dueDate?: { ... }\n dynamicDueDate?: { ... }\n manuallyCreated?: { ... }\n automationConfig?: { ... }\n journey?: { ... }\n taxonomies?: { ... }\n }>\n taxonomies?: string[]\n } | {\n id: string\n definitionId?: string\n entityRefId?: string\n name: string\n description?: {\n enabled?: { ... }\n value?: { ... }\n }\n type: "STEP" | "SECTION"\n ecp?: {\n enabled?: { ... }\n label?: { ... }\n description?: { ... }\n journey?: { ... }\n }\n installer?: {\n enabled?: { ... }\n label?: { ... }\n description?: { ... }\n journey?: { ... }\n }\n enabled?: boolean\n requirements?: Array<{\n definitionId: { ... }\n type: { ... }\n condition: { ... }\n }>\n executionType?: "MANUAL" | "AUTOMATION"\n sectionId?: string\n executionId?: string\n userIds?: number[]\n assignedTo?: string[]\n assignedToInProgress?: string\n assignedToOnHold?: string\n status?: "UNASSIGNED" | "ASSIGNED" | "COMPLETED" | "SKIPPED" | "IN_PROGRESS" | "SCHEDULED" | "PENDING" | "CONDITION_PENDING" | "WAITING_FOR_CONFIRMATION" | "ON_HOLD" | "FAILED"\n created?: string\n lastUpdated?: string\n statusLastUpdated?: string\n startedTime?: string\n completedTime?: string\n dueDate?: string\n dynamicDueDate?: {\n numberOfUnits: { ... }\n timePeriod: { ... }\n actionTypeCondition?: { ... }\n stepId?: { ... }\n phaseId?: { ... }\n }\n // ...\n}\n```\n\n### `WorkflowExecution`\n\n```ts\ntype WorkflowExecution = {\n id?: string\n definitionId?: string\n orgId?: string\n name?: string\n creationTime?: string\n lastUpdateTime?: string\n dueDate?: string\n completedTime?: string\n dynamicDueDate?: {\n numberOfUnits: number\n timePeriod: "minutes" | "hours" | "days" | "weeks" | "months"\n actionTypeCondition?: "WORKFLOW_STARTED" | "STEP_CLOSED" | "PHASE_FINISHED"\n stepId?: string\n phaseId?: string\n }\n status?: "STARTED" | "DONE" | "CLOSED"\n trigger?: "MANUAL" | "AUTOMATIC"\n assignedTo?: string[]\n lastModifiedBy?: string\n contexts?: Array<{\n id: string\n title: string\n schema: string\n }>\n nextOpenStep?: {\n id?: string\n entityRefId?: string\n }\n configuredClosingReasonSnapshot?: Array<{\n id: string\n title: string\n }>\n selectedClosingReasons?: Array<{\n id: string\n title: string\n }>\n closingReasonDescription?: string\n enableECPWorkflow?: boolean\n updateEntityAttributes?: Array<{\n source: "workflow_status" | "current_section" | "current_step"\n target: {\n entitySchema: { ... }\n entityAttribute: { ... }\n }\n }>\n version?: number\n taxonomies?: string[]\n singleClosingReasonSelection?: boolean\n flow: Array<{\n id: string\n definitionId?: string\n name: string\n userIds?: number[]\n assignedTo?: string[]\n dueDate?: string\n dynamicDueDate?: {\n numberOfUnits: { ... }\n timePeriod: { ... }\n actionTypeCondition?: { ... }\n stepId?: { ... }\n phaseId?: { ... }\n }\n startedTime?: string\n completedTime?: string\n status?: "OPEN" | "IN_PROGRESS" | "COMPLETED"\n type: "STEP" | "SECTION"\n steps: Array<{\n id: { ... }\n definitionId?: { ... }\n entityRefId?: { ... }\n name: { ... }\n description?: { ... }\n type: { ... }\n ecp?: { ... }\n installer?: { ... }\n enabled?: { ... }\n requirements?: { ... }\n executionType?: { ... }\n sectionId?: { ... }\n executionId?: { ... }\n userIds?: { ... }\n assignedTo?: { ... }\n assignedToInProgress?: { ... }\n assignedToOnHold?: { ... }\n status?: { ... }\n created?: { ... }\n lastUpdated?: { ... }\n statusLastUpdated?: { ... }\n startedTime?: { ... }\n completedTime?: { ... }\n dueDate?: { ... }\n dynamicDueDate?: { ... }\n manuallyCreated?: { ... }\n automationConfig?: { ... }\n journey?: { ... }\n taxonomies?: { ... }\n }>\n taxonomies?: string[]\n } | {\n // ...\n}\n```\n\n### `WorkflowStatus`\n\n```ts\ntype WorkflowStatus = "STARTED" | "DONE" | "CLOSED"\n```\n\n### `SectionSimplified`\n\nA group of Steps that define the progress of the Workflow\n\n```ts\ntype SectionSimplified = {\n id: string\n definitionId?: string\n name: string\n type: "STEP" | "SECTION"\n steps: Array<{\n id: string\n definitionId?: string\n entityRefId?: string\n name: string\n description?: {\n enabled?: { ... }\n value?: { ... }\n }\n type: "STEP" | "SECTION"\n ecp?: {\n enabled?: { ... }\n label?: { ... }\n description?: { ... }\n journey?: { ... }\n }\n installer?: {\n enabled?: { ... }\n label?: { ... }\n description?: { ... }\n journey?: { ... }\n }\n enabled?: boolean\n requirements?: Array<{\n definitionId: { ... }\n type: { ... }\n condition: { ... }\n }>\n executionType?: "MANUAL" | "AUTOMATION"\n }>\n assignedTo?: string[]\n}\n```\n\n### `Section`\n\nA group of Steps that define the progress of the Workflow\n\n```ts\ntype Section = {\n id: string\n definitionId?: string\n name: string\n userIds?: number[]\n assignedTo?: string[]\n dueDate?: string\n dynamicDueDate?: {\n numberOfUnits: number\n timePeriod: "minutes" | "hours" | "days" | "weeks" | "months"\n actionTypeCondition?: "WORKFLOW_STARTED" | "STEP_CLOSED" | "PHASE_FINISHED"\n stepId?: string\n phaseId?: string\n }\n startedTime?: string\n completedTime?: string\n status?: "OPEN" | "IN_PROGRESS" | "COMPLETED"\n type: "STEP" | "SECTION"\n steps: Array<{\n id: string\n definitionId?: string\n entityRefId?: string\n name: string\n description?: {\n enabled?: { ... }\n value?: { ... }\n }\n type: "STEP" | "SECTION"\n ecp?: {\n enabled?: { ... }\n label?: { ... }\n description?: { ... }\n journey?: { ... }\n }\n installer?: {\n enabled?: { ... }\n label?: { ... }\n description?: { ... }\n journey?: { ... }\n }\n enabled?: boolean\n requirements?: Array<{\n definitionId: { ... }\n type: { ... }\n condition: { ... }\n }>\n executionType?: "MANUAL" | "AUTOMATION"\n sectionId?: string\n executionId?: string\n userIds?: number[]\n assignedTo?: string[]\n assignedToInProgress?: string\n assignedToOnHold?: string\n status?: "UNASSIGNED" | "ASSIGNED" | "COMPLETED" | "SKIPPED" | "IN_PROGRESS" | "SCHEDULED" | "PENDING" | "CONDITION_PENDING" | "WAITING_FOR_CONFIRMATION" | "ON_HOLD" | "FAILED"\n created?: string\n lastUpdated?: string\n statusLastUpdated?: string\n startedTime?: string\n completedTime?: string\n dueDate?: string\n dynamicDueDate?: {\n numberOfUnits: { ... }\n timePeriod: { ... }\n actionTypeCondition?: { ... }\n stepId?: { ... }\n phaseId?: { ... }\n }\n manuallyCreated?: boolean\n automationConfig?: {\n flowId: { ... }\n executionId?: { ... }\n executionStatus?: { ... }\n }\n journey?: {\n id?: { ... }\n journeyId?: { ... }\n name?: { ... }\n complete_task_automatically?: { ... }\n }\n taxonomies?: string[]\n }>\n taxonomies?: string[]\n}\n```\n\n### `StepId`\n\n```ts\ntype StepId = {\n id?: string\n entityRefId?: string\n}\n```\n\n### `StepSimplified`\n\n```ts\ntype StepSimplified = {\n id: string\n definitionId?: string\n entityRefId?: string\n name: string\n description?: {\n enabled?: boolean\n value?: string\n }\n type: "STEP" | "SECTION"\n ecp?: {\n enabled?: boolean\n label?: string\n description?: string\n journey?: {\n id?: { ... }\n journeyId?: { ... }\n name?: { ... }\n complete_task_automatically?: { ... }\n }\n }\n installer?: {\n enabled?: boolean\n label?: string\n description?: string\n journey?: {\n id?: { ... }\n journeyId?: { ... }\n name?: { ... }\n complete_task_automatically?: { ... }\n }\n }\n enabled?: boolean\n requirements?: Array<{\n definitionId: string\n type: "STEP" | "SECTION"\n condition: "CLOSED"\n }>\n executionType?: "MANUAL" | "AUTOMATION"\n}\n```\n\n### `Step`\n\n```ts\ntype Step = {\n id: string\n definitionId?: string\n entityRefId?: string\n name: string\n description?: {\n enabled?: boolean\n value?: string\n }\n type: "STEP" | "SECTION"\n ecp?: {\n enabled?: boolean\n label?: string\n description?: string\n journey?: {\n id?: { ... }\n journeyId?: { ... }\n name?: { ... }\n complete_task_automatically?: { ... }\n }\n }\n installer?: {\n enabled?: boolean\n label?: string\n description?: string\n journey?: {\n id?: { ... }\n journeyId?: { ... }\n name?: { ... }\n complete_task_automatically?: { ... }\n }\n }\n enabled?: boolean\n requirements?: Array<{\n definitionId: string\n type: "STEP" | "SECTION"\n condition: "CLOSED"\n }>\n executionType?: "MANUAL" | "AUTOMATION"\n sectionId?: string\n executionId?: string\n userIds?: number[]\n assignedTo?: string[]\n assignedToInProgress?: string\n assignedToOnHold?: string\n status?: "UNASSIGNED" | "ASSIGNED" | "COMPLETED" | "SKIPPED" | "IN_PROGRESS" | "SCHEDULED" | "PENDING" | "CONDITION_PENDING" | "WAITING_FOR_CONFIRMATION" | "ON_HOLD" | "FAILED"\n created?: string\n lastUpdated?: string\n statusLastUpdated?: string\n startedTime?: string\n completedTime?: string\n dueDate?: string\n dynamicDueDate?: {\n numberOfUnits: number\n timePeriod: "minutes" | "hours" | "days" | "weeks" | "months"\n actionTypeCondition?: "WORKFLOW_STARTED" | "STEP_CLOSED" | "PHASE_FINISHED"\n stepId?: string\n phaseId?: string\n }\n manuallyCreated?: boolean\n automationConfig?: {\n flowId: string\n executionId?: string\n executionStatus?: string\n }\n journey?: {\n id?: string\n journeyId?: string\n name?: string\n complete_task_automatically?: boolean\n }\n taxonomies?: string[]\n}\n```\n\n### `StepExtended`\n\n```ts\ntype StepExtended = {\n executionId: string\n executionName: string\n executionStatus: "STARTED" | "DONE" | "CLOSED"\n contexts?: Array<{\n id: string\n title: string\n schema: string\n }>\n}\n```\n\n### `StepStatus`\n\n**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:\n- **UNASSIGNED**: Step has not been assigned to any user (deprecated - use PENDING instead)\n- **ASSIGNED**: Step has been assi\n\n```ts\ntype StepStatus = "UNASSIGNED" | "ASSIGNED" | "COMPLETED" | "SKIPPED" | "IN_PROGRESS" | "SCHEDULED" | "PENDING" | "CONDITION_PENDING" | "WAITING_FOR_CONFIRMATION" | "ON_HOLD" | "FAILED"\n```\n\n### `SectionStatus`\n\n```ts\ntype SectionStatus = "OPEN" | "IN_PROGRESS" | "COMPLETED"\n```\n\n### `StepType`\n\n```ts\ntype StepType = "MANUAL" | "AUTOMATION"\n```\n\n### `StepJourney`\n\n```ts\ntype StepJourney = {\n id?: string\n journeyId?: string\n name?: string\n complete_task_automatically?: boolean\n}\n```\n\n### `AutomationConfig`\n\nConfiguration for automation execution to run\n\n```ts\ntype AutomationConfig = {\n flowId: string\n executionId?: string\n executionStatus?: string\n}\n```\n\n### `ECPDetails`\n\nDetails regarding ECP for the workflow step\n\n```ts\ntype ECPDetails = {\n enabled?: boolean\n label?: string\n description?: string\n journey?: {\n id?: string\n journeyId?: string\n name?: string\n complete_task_automatically?: boolean\n }\n}\n```\n\n### `StepDescription`\n\nLonger information regarding Task\n\n```ts\ntype StepDescription = {\n enabled?: boolean\n value?: string\n}\n```\n\n### `ItemType`\n\n```ts\ntype ItemType = "STEP" | "SECTION"\n```\n\n### `TriggerType`\n\n```ts\ntype TriggerType = "MANUAL" | "AUTOMATIC"\n```\n\n### `CreateStepReq`\n\n```ts\ntype CreateStepReq = {\n insertionIndex: number\n name: string\n description?: {\n enabled: boolean\n value: string\n }\n status?: "UNASSIGNED" | "ASSIGNED" | "COMPLETED" | "SKIPPED" | "IN_PROGRESS" | "SCHEDULED" | "PENDING" | "CONDITION_PENDING" | "WAITING_FOR_CONFIRMATION" | "ON_HOLD" | "FAILED"\n sectionId?: string\n executionType?: "MANUAL" | "AUTOMATION"\n automationConfig?: {\n flowId: string\n executionId?: string\n executionStatus?: string\n }\n}\n```\n\n### `UpdateStepReq`\n\n```ts\ntype UpdateStepReq = {\n stepId?: string\n entityRefId?: string\n userIds?: number[]\n assignedTo?: string[]\n assignedToInProgress?: string\n assignedToOnHold?: string\n status?: "UNASSIGNED" | "ASSIGNED" | "COMPLETED" | "SKIPPED" | "IN_PROGRESS" | "SCHEDULED" | "PENDING" | "CONDITION_PENDING" | "WAITING_FOR_CONFIRMATION" | "ON_HOLD" | "FAILED"\n dueDate?: string\n dynamicDueDate?: {\n numberOfUnits: number\n timePeriod: "minutes" | "hours" | "days" | "weeks" | "months"\n actionTypeCondition?: "WORKFLOW_STARTED" | "STEP_CLOSED" | "PHASE_FINISHED"\n stepId?: string\n phaseId?: string\n }\n name?: string\n description?: {\n enabled: boolean\n value: string\n }\n position?: {\n index: number\n sectionId?: string\n }\n automationConfig?: {\n flowId: string\n executionId?: string\n executionStatus?: string\n }\n startedTime?: string\n completedTime?: string\n}\n```\n\n### `StepPositionAt`\n\n```ts\ntype StepPositionAt = {\n index: number\n sectionId?: string\n}\n```\n\n### `UpdateStepResp`\n\n```ts\ntype UpdateStepResp = {\n id: string\n definitionId?: string\n entityRefId?: string\n name: string\n description?: {\n enabled?: boolean\n value?: string\n }\n type: "STEP" | "SECTION"\n ecp?: {\n enabled?: boolean\n label?: string\n description?: string\n journey?: {\n id?: { ... }\n journeyId?: { ... }\n name?: { ... }\n complete_task_automatically?: { ... }\n }\n }\n installer?: {\n enabled?: boolean\n label?: string\n description?: string\n journey?: {\n id?: { ... }\n journeyId?: { ... }\n name?: { ... }\n complete_task_automatically?: { ... }\n }\n }\n enabled?: boolean\n requirements?: Array<{\n definitionId: string\n type: "STEP" | "SECTION"\n condition: "CLOSED"\n }>\n executionType?: "MANUAL" | "AUTOMATION"\n sectionId?: string\n executionId?: string\n userIds?: number[]\n assignedTo?: string[]\n assignedToInProgress?: string\n assignedToOnHold?: string\n status?: "UNASSIGNED" | "ASSIGNED" | "COMPLETED" | "SKIPPED" | "IN_PROGRESS" | "SCHEDULED" | "PENDING" | "CONDITION_PENDING" | "WAITING_FOR_CONFIRMATION" | "ON_HOLD" | "FAILED"\n created?: string\n lastUpdated?: string\n statusLastUpdated?: string\n startedTime?: string\n completedTime?: string\n dueDate?: string\n dynamicDueDate?: {\n numberOfUnits: number\n timePeriod: "minutes" | "hours" | "days" | "weeks" | "months"\n actionTypeCondition?: "WORKFLOW_STARTED" | "STEP_CLOSED" | "PHASE_FINISHED"\n stepId?: string\n phaseId?: string\n }\n manuallyCreated?: boolean\n automationConfig?: {\n flowId: string\n executionId?: string\n executionStatus?: string\n }\n journey?: {\n id?: string\n journeyId?: string\n name?: string\n complete_task_automatically?: boolean\n }\n taxonomies?: string[]\n}\n```\n\n### `SearchStepsResp`\n\n```ts\ntype SearchStepsResp = {\n hits?: number\n results?: Array<{\n executionId: string\n executionName: string\n executionStatus: "STARTED" | "DONE" | "CLOSED"\n contexts?: Array<{\n id: { ... }\n title: { ... }\n schema: { ... }\n }>\n }>\n}\n```\n\n### `SearchExecutionsReq`\n\n```ts\ntype SearchExecutionsReq = {\n name?: string\n status?: "STARTED" | "DONE" | "CLOSED"\n includeDoneWorkflows?: boolean\n assignedTo?: string\n sorting?: "A_Z" | "Z_A" | "DUE_DATE_ASC" | "DUE_DATE_DESC" | "TRIGGER_DATE_ASC" | "TRIGGER_DATE_DESC"\n pagination?: {\n orgId?: string\n creationTime?: string\n }\n}\n```\n\n### `SearchExecutionsResp`\n\n```ts\ntype SearchExecutionsResp = {\n executions: Array<{\n id?: string\n definitionId?: string\n orgId?: string\n name?: string\n creationTime?: string\n lastUpdateTime?: string\n dueDate?: string\n completedTime?: string\n dynamicDueDate?: {\n numberOfUnits: { ... }\n timePeriod: { ... }\n actionTypeCondition?: { ... }\n stepId?: { ... }\n phaseId?: { ... }\n }\n status?: "STARTED" | "DONE" | "CLOSED"\n trigger?: "MANUAL" | "AUTOMATIC"\n assignedTo?: string[]\n lastModifiedBy?: string\n contexts?: Array<{\n id: { ... }\n title: { ... }\n schema: { ... }\n }>\n nextOpenStep?: {\n id?: { ... }\n entityRefId?: { ... }\n }\n configuredClosingReasonSnapshot?: Array<{\n id: { ... }\n title: { ... }\n }>\n selectedClosingReasons?: Array<{\n id: { ... }\n title: { ... }\n }>\n closingReasonDescription?: string\n enableECPWorkflow?: boolean\n updateEntityAttributes?: Array<{\n source: { ... }\n target: { ... }\n }>\n version?: number\n taxonomies?: string[]\n singleClosingReasonSelection?: boolean\n flow: Array<{\n id: { ... }\n definitionId?: { ... }\n name: { ... }\n userIds?: { ... }\n assignedTo?: { ... }\n dueDate?: { ... }\n dynamicDueDate?: { ... }\n startedTime?: { ... }\n completedTime?: { ... }\n status?: { ... }\n type: { ... }\n steps: { ... }\n taxonomies?: { ... }\n } | {\n id: { ... }\n definitionId?: { ... }\n entityRefId?: { ... }\n name: { ... }\n description?: { ... }\n type: { ... }\n ecp?: { ... }\n installer?: { ... }\n enabled?: { ... }\n requirements?: { ... }\n executionType?: { ... }\n sectionId?: { ... }\n executionId?: { ... }\n userIds?: { ... }\n assignedTo?: { ... }\n assignedToInProgress?: { ... }\n assignedToOnHold?: { ... }\n status?: { ... }\n created?: { ... }\n lastUpdated?: { ... }\n statusLastUpdated?: { ... }\n startedTime?: { ... }\n completedTime?: { ... }\n dueDate?: { ... }\n dynamicDueDate?: { ... }\n manuallyCreated?: { ... }\n automationConfig?: { ... }\n journey?: { ... }\n taxonomies?: { ... }\n }>\n }>\n lastEvaluatedKey?: {\n orgId?: string\n creationTime?: string\n }\n}\n```\n\n### `LastEvaluatedKey`\n\n```ts\ntype LastEvaluatedKey = {\n orgId?: string\n creationTime?: string\n}\n```\n\n### `SearchStepsReq`\n\n```ts\ntype SearchStepsReq = {\n executionName?: string\n stepName?: string\n assignedTo?: number\n includeDoneWorkflows?: boolean\n manuallyCreated?: boolean\n status?: "OPEN" | "COMPLETE" | "NEXT_OPEN_ITEM_IN_WORKFLOW"\n sorting?: "A_Z" | "Z_A" | "DUE_DATE_ASC" | "DUE_DATE_DESC" | "TRIGGER_DATE_ASC" | "TRIGGER_DATE_DESC"\n pagination?: {\n from?: number\n size?: number\n }\n}\n```\n\n### `SearchSorting`\n\n```ts\ntype SearchSorting = "A_Z" | "Z_A" | "DUE_DATE_ASC" | "DUE_DATE_DESC" | "TRIGGER_DATE_ASC" | "TRIGGER_DATE_DESC"\n```\n\n### `SearchPagination`\n\n```ts\ntype SearchPagination = {\n from?: number\n size?: number\n}\n```\n\n### `ExecutionPaginationDynamo`\n\n```ts\ntype ExecutionPaginationDynamo = {\n orgId?: string\n creationTime?: string\n}\n```\n\n### `ErrorResp`\n\n```ts\ntype ErrorResp = {\n message?: string\n}\n```\n\n### `ClosingReasonResp`\n\n```ts\ntype ClosingReasonResp = {\n reasons?: Array<{\n id: string\n title: string\n }>\n}\n```\n\n### `PhaseInEntity`\n\n```ts\ntype PhaseInEntity = {\n phase_id?: string\n phase_name?: string\n phase_progress?: number\n phase_assignees?: string[]\n}\n```\n\n### `WorkflowInEntity`\n\n```ts\ntype WorkflowInEntity = {\n id?: string\n definition_id?: string\n name?: string\n status?: "STARTED" | "DONE" | "CLOSED"\n assignees?: string[]\n duedate?: string // date-time\n last_update_time?: string // date-time\n progress?: number\n upcoming_tasks_assignees?: string[]\n task_id?: string\n task_name?: string\n task_assignees?: string[]\n task_duedate?: string // date-time\n task_execution_type?: "MANUAL" | "AUTOMATION"\n task_status?: "UNASSIGNED" | "ASSIGNED" | "COMPLETED" | "SKIPPED" | "IN_PROGRESS" | "SCHEDULED" | "PENDING" | "CONDITION_PENDING" | "WAITING_FOR_CONFIRMATION" | "ON_HOLD" | "FAILED"\n phase_id?: string\n phase_name?: string\n phase_assignees?: string[]\n phase_progress?: number\n phases_in_progress?: Array<{\n phase_id?: string\n phase_name?: string\n phase_progress?: number\n phase_assignees?: string[]\n }>\n selected_closing_reasons?: Array<{\n id: string\n title: string\n }>\n closing_reason_description?: string\n}\n```\n\n### `UpdateEntityAttributes`\n\n```ts\ntype UpdateEntityAttributes = {\n source: "workflow_status" | "current_section" | "current_step"\n target: {\n entitySchema: string\n entityAttribute: string\n }\n}\n```\n\n### `EntitySync`\n\n```ts\ntype EntitySync = {\n trigger: {\n event: "FlowStarted" | "FlowCompleted" | "FlowCancelled" | "FlowReopened" | "FlowDeleted" | "FlowAssigned" | "FlowDueDateChanged" | "FlowContextsChanged" | "TaskUpdated" | "CurrTaskChanged" | "TaskCompleted" | "TaskSkipped" | "TaskMarkedInProgress" | "TaskMarkedOnHold" | "PhaseUpdated" | "PhaseCompleted" | "PhaseSkipped" | "PhaseMarkedInProgress"\n filter?: {\n task_template_id?: { ... }\n phase_template_id?: { ... }\n }\n }\n value: {\n source: "workflow_name" | "workflow_status" | "workflow_assigned_to" | "task_name" | "task_status" | "task_assigned_to" | "phase_name" | "phase_status" | "phase_assigned_to" | "custom_value"\n value?: string\n }\n target: {\n entitySchema: string\n entityAttribute: string\n }\n}\n```\n\n### `DynamicDueDate`\n\nset a Duedate for a step then a specific\n\n```ts\ntype DynamicDueDate = {\n numberOfUnits: number\n timePeriod: "minutes" | "hours" | "days" | "weeks" | "months"\n actionTypeCondition?: "WORKFLOW_STARTED" | "STEP_CLOSED" | "PHASE_FINISHED"\n stepId?: string\n phaseId?: string\n}\n```\n\n### `StepRequirement`\n\ndescribe the requirement for step enablement\n\n```ts\ntype StepRequirement = {\n definitionId: string\n type: "STEP" | "SECTION"\n condition: "CLOSED"\n}\n```\n\n### `StartFlowReq`\n\n```ts\ntype StartFlowReq = {\n flow_template_id: string\n trigger?: {\n type?: "MANUAL" | "AUTOMATIC"\n automation_config?: {\n flow_id: { ... }\n execution_id?: { ... }\n execution_status?: { ... }\n error_reason?: { ... }\n }\n }\n contexts: Array<{\n entity_id?: string\n entity_schema?: string\n is_primary?: boolean\n }>\n purposes?: string[]\n}\n```\n\n### `SearchFlowsReq`\n\n```ts\ntype SearchFlowsReq = {\n entity_id: string\n entity_schema: string\n}\n```\n\n### `PatchFlowReq`\n\n```ts\ntype PatchFlowReq = {\n status?: "STARTED" | "DONE" | "CLOSED"\n assigned_to?: Array<string | {\n variable: string\n value?: string[]\n }>\n closing_reason?: {\n selected_reasons?: Array<{\n id: { ... }\n title: { ... }\n }>\n configured_reasons?: Array<{\n id: { ... }\n title: { ... }\n }>\n extra_description?: string\n }\n due_date?: string\n due_date_config?: {\n duration: number\n unit: "minutes" | "hours" | "days" | "weeks" | "months"\n type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"\n task_id?: string\n phase_id?: string\n }\n contexts?: Array<{\n entity_id?: string\n entity_schema?: string\n is_primary?: boolean\n }>\n}\n```\n\n### `FlowExecution`\n\n```ts\ntype FlowExecution = {\n id: string\n flow_template_id: string\n org_id: string\n name: string\n created_at: string\n updated_at: string\n due_date?: string\n due_date_config?: {\n duration: number\n unit: "minutes" | "hours" | "days" | "weeks" | "months"\n type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"\n task_id?: string\n phase_id?: string\n }\n status: "STARTED" | "DONE" | "CLOSED"\n assigned_to?: Array<string | {\n variable: string\n value?: string[]\n }>\n analytics: {\n started_at?: string\n completed_at?: string\n closed_at?: string\n started_by?: string\n closed_by?: string\n }\n contexts: Array<{\n entity_id?: string\n entity_schema?: string\n is_primary?: boolean\n }>\n crt_tasks: Array<{\n id?: string\n }>\n phases?: Array<{\n id: string\n template_id: string\n name: string\n status?: "OPEN" | "IN_PROGRESS" | "COMPLETED"\n updated_at?: string\n due_date?: string\n due_date_config?: {\n duration: { ... }\n unit: { ... }\n type: { ... }\n task_id?: { ... }\n phase_id?: { ... }\n }\n assigned_to?: Array<string | {\n variable: { ... }\n value?: { ... }\n }>\n analytics?: {\n started_at?: { ... }\n in_progress_at?: { ... }\n completed_at?: { ... }\n status_updated_at?: { ... }\n in_progress_by?: { ... }\n completed_by?: { ... }\n skipped_by?: { ... }\n on_hold_by?: { ... }\n }\n taxonomies?: string[]\n loop_config?: {\n max_iterations: { ... }\n crt_iterations?: { ... }\n }\n }>\n tasks: Array<{\n id: string\n template_id: string\n name: string\n description?: {\n enabled?: { ... }\n value?: { ... }\n }\n status: "UNASSIGNED" | "ASSIGNED" | "COMPLETED" | "SKIPPED" | "IN_PROGRESS" | "SCHEDULED" | "PENDING" | "CONDITION_PENDING" | "WAITING_FOR_CONFIRMATION" | "ON_HOLD" | "FAILED"\n journey?: {\n id?: { ... }\n journeyId?: { ... }\n name?: { ... }\n complete_task_automatically?: { ... }\n }\n due_date?: string\n due_date_config?: {\n duration: { ... }\n unit: { ... }\n type: { ... }\n task_id?: { ... }\n phase_id?: { ... }\n }\n requirements?: Array<{\n task_id?: { ... }\n phase_id?: { ... }\n when: { ... }\n }>\n assigned_to?: Array<string | {\n variable: { ... }\n value?: { ... }\n // ...\n}\n```\n\n### `FlowClosingReason`\n\n```ts\ntype FlowClosingReason = {\n selected_reasons?: Array<{\n id: string\n title: string\n }>\n configured_reasons?: Array<{\n id: string\n title: string\n }>\n extra_description?: string\n}\n```\n\n### `FlowTrigger`\n\n```ts\ntype FlowTrigger = {\n type?: "MANUAL" | "AUTOMATIC"\n automation_config?: {\n flow_id: string\n execution_id?: string\n execution_status?: string\n error_reason?: string\n }\n}\n```\n\n### `FlowContext`\n\n```ts\ntype FlowContext = {\n entity_id?: string\n entity_schema?: string\n is_primary?: boolean\n}\n```\n\n### `EntityRef`\n\n```ts\ntype EntityRef = {\n entity_id?: string\n entity_schema?: string\n is_primary?: boolean\n}\n```\n\n### `PhaseId`\n\n```ts\ntype PhaseId = string\n```\n\n### `TaskId`\n\n```ts\ntype TaskId = string\n```\n\n### `Task`\n\n```ts\ntype Task = {\n id: string\n template_id: string\n name: string\n description?: {\n enabled?: boolean\n value?: string\n }\n status: "UNASSIGNED" | "ASSIGNED" | "COMPLETED" | "SKIPPED" | "IN_PROGRESS" | "SCHEDULED" | "PENDING" | "CONDITION_PENDING" | "WAITING_FOR_CONFIRMATION" | "ON_HOLD" | "FAILED"\n journey?: {\n id?: string\n journeyId?: string\n name?: string\n complete_task_automatically?: boolean\n }\n due_date?: string\n due_date_config?: {\n duration: number\n unit: "minutes" | "hours" | "days" | "weeks" | "months"\n type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"\n task_id?: string\n phase_id?: string\n }\n requirements?: Array<{\n task_id?: string\n phase_id?: string\n when: "TASK_FINISHED" | "PHASE_FINISHED"\n }>\n assigned_to?: Array<string | {\n variable: string\n value?: string[]\n }>\n analytics: {\n started_at?: string // date-time\n in_progress_at?: string // date-time\n completed_at?: string // date-time\n status_updated_at?: string // date-time\n in_progress_by?: string\n completed_by?: string\n skipped_by?: string\n on_hold_by?: string\n }\n created_at?: string // date-time\n updated_at?: string // date-time\n manually_created?: boolean\n enabled: boolean\n ecp?: {\n enabled?: boolean\n label?: string\n description?: string\n journey?: {\n id?: { ... }\n journeyId?: { ... }\n name?: { ... }\n complete_task_automatically?: { ... }\n }\n }\n installer?: {\n enabled?: boolean\n label?: string\n description?: string\n journey?: {\n id?: { ... }\n journeyId?: { ... }\n name?: { ... }\n complete_task_automatically?: { ... }\n }\n }\n taxonomies?: string[]\n phase_id?: string\n task_type: "MANUAL" | "AUTOMATION" | "DECISION" | "AI_AGENT"\n loop_config?: {\n max_iterations: number\n crt_iterations?: number\n }\n} | {\n id: string\n template_id: string\n name: string\n description?: {\n enabled?: boolean\n value?: string\n }\n status: "UNASSIGNED" | "ASSIGNED" | "COMPLETED" | "SKIPPED" | "IN_PROGRESS" | "SCHEDULED" | "PENDING" | "CONDITION_PENDING" | "WAITING_FOR_CONFIRMATION" | "ON_HOLD" | "FAILED"\n journey?: {\n id?: string\n journeyId?: string\n name?: string\n complete_task_automatically?: boolean\n }\n due_date?: string\n due_date_config?: {\n duration: number\n unit: "minutes" | "hours" | "days" | "weeks" | "months"\n type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"\n task_id?: string\n phase_id?: string\n }\n requirements?: Array<{\n task_id?: string\n // ...\n}\n```\n\n### `TaskType`\n\n```ts\ntype TaskType = "MANUAL" | "AUTOMATION" | "DECISION" | "AI_AGENT"\n```\n\n### `ManualTask`\n\n```ts\ntype ManualTask = {\n id: string\n template_id: string\n name: string\n description?: {\n enabled?: boolean\n value?: string\n }\n status: "UNASSIGNED" | "ASSIGNED" | "COMPLETED" | "SKIPPED" | "IN_PROGRESS" | "SCHEDULED" | "PENDING" | "CONDITION_PENDING" | "WAITING_FOR_CONFIRMATION" | "ON_HOLD" | "FAILED"\n journey?: {\n id?: string\n journeyId?: string\n name?: string\n complete_task_automatically?: boolean\n }\n due_date?: string\n due_date_config?: {\n duration: number\n unit: "minutes" | "hours" | "days" | "weeks" | "months"\n type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"\n task_id?: string\n phase_id?: string\n }\n requirements?: Array<{\n task_id?: string\n phase_id?: string\n when: "TASK_FINISHED" | "PHASE_FINISHED"\n }>\n assigned_to?: Array<string | {\n variable: string\n value?: string[]\n }>\n analytics: {\n started_at?: string // date-time\n in_progress_at?: string // date-time\n completed_at?: string // date-time\n status_updated_at?: string // date-time\n in_progress_by?: string\n completed_by?: string\n skipped_by?: string\n on_hold_by?: string\n }\n created_at?: string // date-time\n updated_at?: string // date-time\n manually_created?: boolean\n enabled: boolean\n ecp?: {\n enabled?: boolean\n label?: string\n description?: string\n journey?: {\n id?: { ... }\n journeyId?: { ... }\n name?: { ... }\n complete_task_automatically?: { ... }\n }\n }\n installer?: {\n enabled?: boolean\n label?: string\n description?: string\n journey?: {\n id?: { ... }\n journeyId?: { ... }\n name?: { ... }\n complete_task_automatically?: { ... }\n }\n }\n taxonomies?: string[]\n phase_id?: string\n task_type: "MANUAL" | "AUTOMATION" | "DECISION" | "AI_AGENT"\n loop_config?: {\n max_iterations: number\n crt_iterations?: number\n }\n}\n```\n\n### `AutomationTask`\n\n```ts\ntype AutomationTask = {\n id: string\n template_id: string\n name: string\n description?: {\n enabled?: boolean\n value?: string\n }\n status: "UNASSIGNED" | "ASSIGNED" | "COMPLETED" | "SKIPPED" | "IN_PROGRESS" | "SCHEDULED" | "PENDING" | "CONDITION_PENDING" | "WAITING_FOR_CONFIRMATION" | "ON_HOLD" | "FAILED"\n journey?: {\n id?: string\n journeyId?: string\n name?: string\n complete_task_automatically?: boolean\n }\n due_date?: string\n due_date_config?: {\n duration: number\n unit: "minutes" | "hours" | "days" | "weeks" | "months"\n type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"\n task_id?: string\n phase_id?: string\n }\n requirements?: Array<{\n task_id?: string\n phase_id?: string\n when: "TASK_FINISHED" | "PHASE_FINISHED"\n }>\n assigned_to?: Array<string | {\n variable: string\n value?: string[]\n }>\n analytics: {\n started_at?: string // date-time\n in_progress_at?: string // date-time\n completed_at?: string // date-time\n status_updated_at?: string // date-time\n in_progress_by?: string\n completed_by?: string\n skipped_by?: string\n on_hold_by?: string\n }\n created_at?: string // date-time\n updated_at?: string // date-time\n manually_created?: boolean\n enabled: boolean\n ecp?: {\n enabled?: boolean\n label?: string\n description?: string\n journey?: {\n id?: { ... }\n journeyId?: { ... }\n name?: { ... }\n complete_task_automatically?: { ... }\n }\n }\n installer?: {\n enabled?: boolean\n label?: string\n description?: string\n journey?: {\n id?: { ... }\n journeyId?: { ... }\n name?: { ... }\n complete_task_automatically?: { ... }\n }\n }\n taxonomies?: string[]\n phase_id?: string\n task_type: "MANUAL" | "AUTOMATION" | "DECISION" | "AI_AGENT"\n automation_config: {\n flow_id: string\n execution_id?: string\n execution_status?: string\n error_reason?: string\n }\n automation_execution_id?: string\n trigger_mode?: "manual" | "automatic"\n schedule?: {\n mode: "immediate"\n } | {\n mode: "delayed"\n duration: number\n unit: "minutes" | "hours" | "days" | "weeks" | "months"\n schedule_id?: string\n } | {\n mode: "relative"\n direction: "before" | "after"\n duration: number\n unit: "minutes" | "hours" | "days" | "weeks" | "months"\n reference: {\n id: { ... }\n origin: { ... }\n schema?: { ... }\n attribute?: { ... }\n }\n schedule_id?: string\n }\n loop_config?: {\n // ...\n}\n```\n\n### `LoopInfo`\n\nInformation about loop iterations, when task is part of a loop branch\n\n```ts\ntype LoopInfo = {\n max_iterations: number\n crt_iterations?: number\n}\n```\n\n### `LoopConfig`\n\n```ts\ntype LoopConfig = {\n loop_branch_id: string\n exit_branch_id: string\n max_iterations: number\n crt_iterations?: number\n}\n```\n\n### `TriggerMode`\n\n```ts\ntype TriggerMode = "manual" | "automatic"\n```\n\n### `ActionSchedule`\n\n```ts\ntype ActionSchedule = {\n mode: "immediate"\n} | {\n mode: "delayed"\n duration: number\n unit: "minutes" | "hours" | "days" | "weeks" | "months"\n schedule_id?: string\n} | {\n mode: "relative"\n direction: "before" | "after"\n duration: number\n unit: "minutes" | "hours" | "days" | "weeks" | "months"\n reference: {\n id: string\n origin: "flow_started" | "task_completed" | "trigger_entity_attribute" | "all_preceding_tasks_completed"\n schema?: string\n attribute?: string\n }\n schedule_id?: string\n}\n```\n\n### `ImmediateSchedule`\n\n```ts\ntype ImmediateSchedule = {\n mode: "immediate"\n}\n```\n\n### `DelayedSchedule`\n\n```ts\ntype DelayedSchedule = {\n mode: "delayed"\n duration: number\n unit: "minutes" | "hours" | "days" | "weeks" | "months"\n schedule_id?: string\n}\n```\n\n### `RelativeSchedule`\n\n```ts\ntype RelativeSchedule = {\n mode: "relative"\n direction: "before" | "after"\n duration: number\n unit: "minutes" | "hours" | "days" | "weeks" | "months"\n reference: {\n id: string\n origin: "flow_started" | "task_completed" | "trigger_entity_attribute" | "all_preceding_tasks_completed"\n schema?: string\n attribute?: string\n }\n schedule_id?: string\n}\n```\n\n### `DecisionTask`\n\n```ts\ntype DecisionTask = {\n id: string\n template_id: string\n name: string\n description?: {\n enabled?: boolean\n value?: string\n }\n status: "UNASSIGNED" | "ASSIGNED" | "COMPLETED" | "SKIPPED" | "IN_PROGRESS" | "SCHEDULED" | "PENDING" | "CONDITION_PENDING" | "WAITING_FOR_CONFIRMATION" | "ON_HOLD" | "FAILED"\n journey?: {\n id?: string\n journeyId?: string\n name?: string\n complete_task_automatically?: boolean\n }\n due_date?: string\n due_date_config?: {\n duration: number\n unit: "minutes" | "hours" | "days" | "weeks" | "months"\n type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"\n task_id?: string\n phase_id?: string\n }\n requirements?: Array<{\n task_id?: string\n phase_id?: string\n when: "TASK_FINISHED" | "PHASE_FINISHED"\n }>\n assigned_to?: Array<string | {\n variable: string\n value?: string[]\n }>\n analytics: {\n started_at?: string // date-time\n in_progress_at?: string // date-time\n completed_at?: string // date-time\n status_updated_at?: string // date-time\n in_progress_by?: string\n completed_by?: string\n skipped_by?: string\n on_hold_by?: string\n }\n created_at?: string // date-time\n updated_at?: string // date-time\n manually_created?: boolean\n enabled: boolean\n ecp?: {\n enabled?: boolean\n label?: string\n description?: string\n journey?: {\n id?: { ... }\n journeyId?: { ... }\n name?: { ... }\n complete_task_automatically?: { ... }\n }\n }\n installer?: {\n enabled?: boolean\n label?: string\n description?: string\n journey?: {\n id?: { ... }\n journeyId?: { ... }\n name?: { ... }\n complete_task_automatically?: { ... }\n }\n }\n taxonomies?: string[]\n phase_id?: string\n task_type: "MANUAL" | "AUTOMATION" | "DECISION" | "AI_AGENT"\n trigger_mode: "manual" | "automatic"\n conditions: Array<{\n id: string\n branch_name: string\n logical_operator: "AND" | "OR"\n statements: Array<{\n id: { ... }\n source: { ... }\n operator: { ... }\n values: { ... }\n value_type?: { ... }\n }>\n evaluated_at?: string // date-time\n is_met?: boolean\n }>\n schedule?: {\n mode: "delayed"\n duration: number\n unit: "minutes" | "hours" | "days" | "weeks" | "months"\n schedule_id?: string\n } | {\n mode: "relative"\n direction: "before" | "after"\n duration: number\n unit: "minutes" | "hours" | "days" | "weeks" | "months"\n reference: {\n id: { ... }\n origin: { ... }\n schema?: { ... }\n // ...\n}\n```\n\n### `AiAgentTask`\n\n```ts\ntype AiAgentTask = {\n id: string\n template_id: string\n name: string\n description?: {\n enabled?: boolean\n value?: string\n }\n status: "UNASSIGNED" | "ASSIGNED" | "COMPLETED" | "SKIPPED" | "IN_PROGRESS" | "SCHEDULED" | "PENDING" | "CONDITION_PENDING" | "WAITING_FOR_CONFIRMATION" | "ON_HOLD" | "FAILED"\n journey?: {\n id?: string\n journeyId?: string\n name?: string\n complete_task_automatically?: boolean\n }\n due_date?: string\n due_date_config?: {\n duration: number\n unit: "minutes" | "hours" | "days" | "weeks" | "months"\n type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"\n task_id?: string\n phase_id?: string\n }\n requirements?: Array<{\n task_id?: string\n phase_id?: string\n when: "TASK_FINISHED" | "PHASE_FINISHED"\n }>\n assigned_to?: Array<string | {\n variable: string\n value?: string[]\n }>\n analytics: {\n started_at?: string // date-time\n in_progress_at?: string // date-time\n completed_at?: string // date-time\n status_updated_at?: string // date-time\n in_progress_by?: string\n completed_by?: string\n skipped_by?: string\n on_hold_by?: string\n }\n created_at?: string // date-time\n updated_at?: string // date-time\n manually_created?: boolean\n enabled: boolean\n ecp?: {\n enabled?: boolean\n label?: string\n description?: string\n journey?: {\n id?: { ... }\n journeyId?: { ... }\n name?: { ... }\n complete_task_automatically?: { ... }\n }\n }\n installer?: {\n enabled?: boolean\n label?: string\n description?: string\n journey?: {\n id?: { ... }\n journeyId?: { ... }\n name?: { ... }\n complete_task_automatically?: { ... }\n }\n }\n taxonomies?: string[]\n phase_id?: string\n task_type: "MANUAL" | "AUTOMATION" | "DECISION" | "AI_AGENT"\n agent_config?: {\n agent_id: string\n parameters?: object\n }\n loop_config?: {\n max_iterations: number\n crt_iterations?: number\n }\n agent_execution?: {\n execution_id?: string\n execution_status?: string\n error_reason?: string\n }\n agent_execution_id?: string\n}\n```\n\n### `AgentConfig`\n\nConfiguration for AI Agent to run\n\n```ts\ntype AgentConfig = {\n agent_id: string\n parameters?: object\n}\n```\n\n### `AgentExecutionInfo`\n\n```ts\ntype AgentExecutionInfo = {\n execution_id?: string\n execution_status?: string\n error_reason?: string\n}\n```\n\n### `TaskBase`\n\n```ts\ntype TaskBase = {\n id: string\n template_id: string\n name: string\n description?: {\n enabled?: boolean\n value?: string\n }\n status: "UNASSIGNED" | "ASSIGNED" | "COMPLETED" | "SKIPPED" | "IN_PROGRESS" | "SCHEDULED" | "PENDING" | "CONDITION_PENDING" | "WAITING_FOR_CONFIRMATION" | "ON_HOLD" | "FAILED"\n journey?: {\n id?: string\n journeyId?: string\n name?: string\n complete_task_automatically?: boolean\n }\n due_date?: string\n due_date_config?: {\n duration: number\n unit: "minutes" | "hours" | "days" | "weeks" | "months"\n type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"\n task_id?: string\n phase_id?: string\n }\n requirements?: Array<{\n task_id?: string\n phase_id?: string\n when: "TASK_FINISHED" | "PHASE_FINISHED"\n }>\n assigned_to?: Array<string | {\n variable: string\n value?: string[]\n }>\n analytics: {\n started_at?: string // date-time\n in_progress_at?: string // date-time\n completed_at?: string // date-time\n status_updated_at?: string // date-time\n in_progress_by?: string\n completed_by?: string\n skipped_by?: string\n on_hold_by?: string\n }\n created_at?: string // date-time\n updated_at?: string // date-time\n manually_created?: boolean\n enabled: boolean\n ecp?: {\n enabled?: boolean\n label?: string\n description?: string\n journey?: {\n id?: { ... }\n journeyId?: { ... }\n name?: { ... }\n complete_task_automatically?: { ... }\n }\n }\n installer?: {\n enabled?: boolean\n label?: string\n description?: string\n journey?: {\n id?: { ... }\n journeyId?: { ... }\n name?: { ... }\n complete_task_automatically?: { ... }\n }\n }\n taxonomies?: string[]\n phase_id?: string\n task_type: "MANUAL" | "AUTOMATION" | "DECISION" | "AI_AGENT"\n}\n```\n\n### `Phase`\n\n```ts\ntype Phase = {\n id: string\n template_id: string\n name: string\n status?: "OPEN" | "IN_PROGRESS" | "COMPLETED"\n updated_at?: string\n due_date?: string\n due_date_config?: {\n duration: number\n unit: "minutes" | "hours" | "days" | "weeks" | "months"\n type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"\n task_id?: string\n phase_id?: string\n }\n assigned_to?: Array<string | {\n variable: string\n value?: string[]\n }>\n analytics?: {\n started_at?: string // date-time\n in_progress_at?: string // date-time\n completed_at?: string // date-time\n status_updated_at?: string // date-time\n in_progress_by?: string\n completed_by?: string\n skipped_by?: string\n on_hold_by?: string\n }\n taxonomies?: string[]\n loop_config?: {\n max_iterations: number\n crt_iterations?: number\n }\n}\n```\n\n### `Edge`\n\n```ts\ntype Edge = {\n id: string\n from_id: string\n to_id: string\n condition_id?: string\n none_met?: boolean\n}\n```\n\n### `AutomationInfo`\n\n```ts\ntype AutomationInfo = {\n flow_id: string\n execution_id?: string\n execution_status?: string\n error_reason?: string\n}\n```\n\n### `AnalyticsInfo`\n\n```ts\ntype AnalyticsInfo = {\n started_at?: string // date-time\n in_progress_at?: string // date-time\n completed_at?: string // date-time\n status_updated_at?: string // date-time\n in_progress_by?: string\n completed_by?: string\n skipped_by?: string\n on_hold_by?: string\n}\n```\n\n### `ConditionId`\n\nA locally unique identifier for the condition\n\n```ts\ntype ConditionId = string\n```\n\n### `Condition`\n\n```ts\ntype Condition = {\n id: string\n branch_name: string\n logical_operator: "AND" | "OR"\n statements: Array<{\n id: string\n source: {\n id?: { ... }\n origin?: { ... }\n origin_type?: { ... }\n schema?: { ... }\n attribute?: { ... }\n attribute_type?: { ... }\n attribute_repeatable?: { ... }\n attribute_operation?: { ... }\n attribute_sub_field?: { ... }\n date_offset?: { ... }\n }\n 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"\n values: string[]\n value_type?: "static" | "relative_date"\n }>\n evaluated_at?: string // date-time\n is_met?: boolean\n}\n```\n\n### `Statement`\n\n```ts\ntype Statement = {\n id: string\n source: {\n id?: string\n origin?: "trigger" | "action"\n origin_type?: "entity" | "workflow" | "journey_block"\n schema?: string\n attribute?: string\n 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"\n attribute_repeatable?: boolean\n attribute_operation?: "all" | "updated" | "added" | "deleted"\n attribute_sub_field?: string\n date_offset?: {\n amount?: { ... }\n unit?: { ... }\n }\n }\n 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"\n values: string[]\n value_type?: "static" | "relative_date"\n}\n```\n\n### `EvaluationSource`\n\n```ts\ntype EvaluationSource = {\n id?: string\n origin?: "trigger" | "action"\n origin_type?: "entity" | "workflow" | "journey_block"\n schema?: string\n attribute?: string\n 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"\n attribute_repeatable?: boolean\n attribute_operation?: "all" | "updated" | "added" | "deleted"\n attribute_sub_field?: string\n date_offset?: {\n amount?: number\n unit?: "days" | "months" | "years"\n }\n}\n```\n\n### `Operator`\n\n```ts\ntype 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"\n```\n\n### `DueDateConfig`\n\nSet due date for the task based on a dynamic condition\n\n```ts\ntype DueDateConfig = {\n duration: number\n unit: "minutes" | "hours" | "days" | "weeks" | "months"\n type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"\n task_id?: string\n phase_id?: string\n}\n```\n\n### `TimeUnit`\n\n```ts\ntype TimeUnit = "minutes" | "hours" | "days" | "weeks" | "months"\n```\n\n### `EnableRequirement`\n\ndescribe the requirement for a task to be enabled\n\n```ts\ntype EnableRequirement = {\n task_id?: string\n phase_id?: string\n when: "TASK_FINISHED" | "PHASE_FINISHED"\n}\n```\n\n### `FlowTemplateId`\n\n```ts\ntype FlowTemplateId = string\n```\n\n### `FlowExecutionId`\n\n```ts\ntype FlowExecutionId = string\n```\n\n### `UserId`\n\nThe user id\n\n```ts\ntype UserId = string\n```\n\n### `VariableAssignment`\n\nRepresents a variable assignment with its expression and optional resolved value. Used for dynamic user assignments that get resolved during workflow execution.\n\n```ts\ntype VariableAssignment = {\n variable: string\n value?: string[]\n}\n```\n\n### `Assignees`\n\nThe user ids or variable assignments\n\n```ts\ntype Assignees = Array<string | {\n variable: string\n value?: string[]\n}>\n```\n\n### `PatchTaskReq`\n\n```ts\ntype PatchTaskReq = {\n name?: string\n status?: "UNASSIGNED" | "ASSIGNED" | "COMPLETED" | "SKIPPED" | "IN_PROGRESS" | "SCHEDULED" | "PENDING" | "CONDITION_PENDING" | "WAITING_FOR_CONFIRMATION" | "ON_HOLD" | "FAILED"\n due_date?: string\n due_date_config?: {\n duration: number\n unit: "minutes" | "hours" | "days" | "weeks" | "months"\n type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"\n task_id?: string\n phase_id?: string\n }\n assigned_to?: Array<string | {\n variable: string\n value?: string[]\n }>\n enabled?: boolean\n automation_config?: {\n flow_id: string\n execution_id?: string\n execution_status?: string\n error_reason?: string\n }\n description?: {\n enabled?: boolean\n value?: string\n }\n ecp?: {\n enabled?: boolean\n label?: string\n description?: string\n journey?: {\n id?: { ... }\n journeyId?: { ... }\n name?: { ... }\n complete_task_automatically?: { ... }\n }\n }\n installer?: {\n enabled?: boolean\n label?: string\n description?: string\n journey?: {\n id?: { ... }\n journeyId?: { ... }\n name?: { ... }\n complete_task_automatically?: { ... }\n }\n }\n next_condition_id?: string\n revert_execution?: boolean\n}\n```\n\n### `PatchPhaseReq`\n\n```ts\ntype PatchPhaseReq = {\n name?: string\n due_date?: string\n due_date_config?: {\n duration: number\n unit: "minutes" | "hours" | "days" | "weeks" | "months"\n type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"\n task_id?: string\n phase_id?: string\n }\n assigned_to?: Array<string | {\n variable: string\n value?: string[]\n }>\n}\n```\n\n### `AddTaskReq`\n\n```ts\ntype AddTaskReq = {\n previous_task_id: string // uuid\n next_task_id: string // uuid\n task: {\n id?: string // uuid\n name: string\n status?: "UNASSIGNED" | "ASSIGNED" | "COMPLETED" | "SKIPPED" | "IN_PROGRESS" | "SCHEDULED" | "PENDING" | "CONDITION_PENDING" | "WAITING_FOR_CONFIRMATION" | "ON_HOLD" | "FAILED"\n due_date?: string\n due_date_config?: {\n duration: { ... }\n unit: { ... }\n type: { ... }\n task_id?: { ... }\n phase_id?: { ... }\n }\n assigned_to?: Array<string | {\n variable: { ... }\n value?: { ... }\n }>\n enabled?: boolean\n automation_config?: {\n flow_id: { ... }\n execution_id?: { ... }\n execution_status?: { ... }\n error_reason?: { ... }\n }\n phase_id?: string\n task_type?: "MANUAL" | "AUTOMATION" | "DECISION" | "AI_AGENT"\n }\n}\n```\n';
|
|
5
|
+
export {
|
|
6
|
+
workflow_default as default
|
|
7
|
+
};
|