@epilot/sdk 2.14.0 → 2.14.2

package/dist/workflow-definition-XTWO4RMY.cjs

@@ -0,0 +1,7 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
+
+// src/docs/workflow-definition.json
+var workflow_definition_default = '# Workflows Definitions\n\n- **Base URL:** `https://workflows-definition.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/workflow-definition](https://docs.epilot.io/api/workflow-definition)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.workflowDefinition.getMaxAllowedLimit(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/workflow-definition\'\n\nconst workflowDefinitionClient = getClient()\nauthorize(workflowDefinitionClient, () => \'<token>\')\nconst { data } = await workflowDefinitionClient.getMaxAllowedLimit(...)\n```\n\n## Operations\n\n**Workflows**\n- [`getMaxAllowedLimit`](#getmaxallowedlimit)\n- [`getDefinitions`](#getdefinitions)\n- [`createDefinition`](#createdefinition)\n- [`getDefinition`](#getdefinition)\n- [`updateDefinition`](#updatedefinition)\n- [`deleteDefinition`](#deletedefinition)\n- [`getWorkflowClosingReasons`](#getworkflowclosingreasons)\n- [`setWorkflowClosingReasons`](#setworkflowclosingreasons)\n\n**Flows V2**\n- [`listFlowTemplates`](#listflowtemplates)\n- [`createFlowTemplate`](#createflowtemplate)\n- [`searchFlowTemplates`](#searchflowtemplates)\n- [`getFlowTemplate`](#getflowtemplate)\n- [`updateFlowTemplate`](#updateflowtemplate)\n- [`deleteFlowTemplate`](#deleteflowtemplate)\n- [`duplicateFlowTemplate`](#duplicateflowtemplate)\n\n**Closing Reason**\n- [`getAllClosingReasons`](#getallclosingreasons)\n- [`createClosingReason`](#createclosingreason)\n- [`getClosingReason`](#getclosingreason)\n- [`updateClosingReason`](#updateclosingreason)\n- [`deleteClosingReason`](#deleteclosingreason)\n- [`changeReasonStatus`](#changereasonstatus)\n\n**Schemas**\n- [`FlowTemplateBase`](#flowtemplatebase)\n- [`FlowLimitWarning`](#flowlimitwarning)\n- [`FlowTemplate`](#flowtemplate)\n- [`Version`](#version)\n- [`Trigger`](#trigger)\n- [`ManualTrigger`](#manualtrigger)\n- [`AutomationTrigger`](#automationtrigger)\n- [`JourneyAutomationTrigger`](#journeyautomationtrigger)\n- [`JourneySubmissionTrigger`](#journeysubmissiontrigger)\n- [`CreateFlowTemplate`](#createflowtemplate)\n- [`SearchFlowTemplates`](#searchflowtemplates)\n- [`FlowTemplatesList`](#flowtemplateslist)\n- [`FlowTemplateId`](#flowtemplateid)\n- [`Task`](#task)\n- [`ManualTask`](#manualtask)\n- [`AutomationTask`](#automationtask)\n- [`AutomationConfig`](#automationconfig)\n- [`AutomationInputContext`](#automationinputcontext)\n- [`AiAgentTask`](#aiagenttask)\n- [`AgentConfig`](#agentconfig)\n- [`TriggerMode`](#triggermode)\n- [`ActionSchedule`](#actionschedule)\n- [`ImmediateSchedule`](#immediateschedule)\n- [`DelayedSchedule`](#delayedschedule)\n- [`RelativeSchedule`](#relativeschedule)\n- [`DecisionTask`](#decisiontask)\n- [`TaskBase`](#taskbase)\n- [`Phase`](#phase)\n- [`VariableAssignment`](#variableassignment)\n- [`TaskType`](#tasktype)\n- [`Edge`](#edge)\n- [`Condition`](#condition)\n- [`Statement`](#statement)\n- [`EvaluationSource`](#evaluationsource)\n- [`Operator`](#operator)\n- [`DueDateConfig`](#duedateconfig)\n- [`TimeUnit`](#timeunit)\n- [`EnableRequirement`](#enablerequirement)\n- [`WorkflowDefinition`](#workflowdefinition)\n- [`Step`](#step)\n- [`Section`](#section)\n- [`TriggerType`](#triggertype)\n- [`ItemType`](#itemtype)\n- [`StepType`](#steptype)\n- [`StepJourney`](#stepjourney)\n- [`ECPDetails`](#ecpdetails)\n- [`PartnerDetails`](#partnerdetails)\n- [`StepDescription`](#stepdescription)\n- [`MaxAllowedLimit`](#maxallowedlimit)\n- [`DefinitionNotFoundResp`](#definitionnotfoundresp)\n- [`ClosingReasonNotFoundResp`](#closingreasonnotfoundresp)\n- [`ChangeReasonStatusReq`](#changereasonstatusreq)\n- [`ClosingReasons`](#closingreasons)\n- [`ClosingReason`](#closingreason)\n- [`ClosingReasonsStatus`](#closingreasonsstatus)\n- [`ClosingReasonsIds`](#closingreasonsids)\n- [`ClosingReasonId`](#closingreasonid)\n- [`ErrorResp`](#errorresp)\n- [`UpdateEntityAttributes`](#updateentityattributes)\n- [`EntitySync`](#entitysync)\n- [`DynamicDueDate`](#dynamicduedate)\n- [`StepRequirement`](#steprequirement)\n\n### `getMaxAllowedLimit`\n\nGet limits and number of created executions for an Organization.\n\n`GET /v1/workflows/limits/max-allowed`\n\n```ts\nconst { data } = await client.getMaxAllowedLimit()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "currentNoOfWorkflows": 0,\n  "maxAllowed": 0\n}\n```\n\n</details>\n\n---\n\n### `getDefinitions`\n\nRetrieve all V1 workflow definitions belonging to the authenticated organization.\n\n`GET /v1/workflows/definitions`\n\n```ts\nconst { data } = await client.getDefinitions()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n  {\n    "id": "string",\n    "name": "string",\n    "description": "string",\n    "creationTime": "2021-04-27T12:01:13.000Z",\n    "enabled": true,\n    "lastUpdateTime": "2021-04-27T12:01:13.000Z",\n    "dueDate": "2021-04-27T12:00:00.000Z",\n    "dynamicDueDate": {\n      "numberOfUnits": 0,\n      "timePeriod": "minutes",\n      "actionTypeCondition": "WORKFLOW_STARTED",\n      "stepId": "string",\n      "phaseId": "string"\n    },\n    "userIds": [0],\n    "assignedTo": ["string"],\n    "enableECPWorkflow": true,\n    "flow": [\n      {},\n      {}\n    ],\n    "closingReasons": [\n      {}\n    ],\n    "updateEntityAttributes": [\n      {}\n    ],\n    "taxonomies": ["string"],\n    "singleClosingReasonSelection": true,\n    "_manifest": ["string"]\n  }\n]\n```\n\n</details>\n\n---\n\n### `createDefinition`\n\nCreate a new V1 workflow definition. The definition consists of sections and steps\nthat define the structure of the workflow. Once created, the definition can be used\nto start workflow executions.\n\n`POST /v1/workflows/definitions`\n\n```ts\nconst { data } = await client.createDefinition(\n  null,\n  {\n    id: \'string\',\n    name: \'string\',\n    description: \'string\',\n    creationTime: \'2021-04-27T12:01:13.000Z\',\n    enabled: true,\n    lastUpdateTime: \'2021-04-27T12:01:13.000Z\',\n    dueDate: \'2021-04-27T12:00:00.000Z\',\n    dynamicDueDate: {\n      numberOfUnits: 0,\n      timePeriod: \'minutes\',\n      actionTypeCondition: \'WORKFLOW_STARTED\',\n      stepId: \'string\',\n      phaseId: \'string\'\n    },\n    userIds: [0],\n    assignedTo: [\'string\'],\n    enableECPWorkflow: true,\n    flow: [\n      {\n        id: \'string\',\n        name: \'string\',\n        order: 0,\n        type: \'STEP\',\n        dueDate: \'2021-04-27T12:00:00.000Z\',\n        dynamicDueDate: { /* ... */ },\n        assignedTo: [\'string\'],\n        steps: [ /* ... */ ],\n        taxonomies: [\'string\']\n      },\n      {\n        id: \'string\',\n        name: \'string\',\n        description: { /* ... */ },\n        executionType: \'MANUAL\',\n        automationConfig: { /* ... */ },\n        journey: { /* ... */ },\n        order: 0,\n        dueDate: \'2021-04-27T12:00:00.000Z\',\n        dynamicDueDate: { /* ... */ },\n        userIds: [0],\n        requirements: [ /* ... */ ],\n        assignedTo: [\'string\'],\n        type: \'STEP\',\n        ecp: { /* ... */ },\n        installer: { /* ... */ },\n        partner: { /* ... */ },\n        taxonomies: [\'string\']\n      }\n    ],\n    closingReasons: [\n      {\n        id: \'x739cew\'\n      }\n    ],\n    updateEntityAttributes: [\n      {\n        source: \'workflow_status\',\n        target: { /* ... */ }\n      }\n    ],\n    taxonomies: [\'string\'],\n    singleClosingReasonSelection: true,\n    _manifest: [\'string\']\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "string",\n  "name": "string",\n  "description": "string",\n  "creationTime": "2021-04-27T12:01:13.000Z",\n  "enabled": true,\n  "lastUpdateTime": "2021-04-27T12:01:13.000Z",\n  "dueDate": "2021-04-27T12:00:00.000Z",\n  "dynamicDueDate": {\n    "numberOfUnits": 0,\n    "timePeriod": "minutes",\n    "actionTypeCondition": "WORKFLOW_STARTED",\n    "stepId": "string",\n    "phaseId": "string"\n  },\n  "userIds": [0],\n  "assignedTo": ["string"],\n  "enableECPWorkflow": true,\n  "flow": [\n    {\n      "id": "string",\n      "name": "string",\n      "order": 0,\n      "type": "STEP",\n      "dueDate": "2021-04-27T12:00:00.000Z",\n      "dynamicDueDate": {},\n      "assignedTo": ["string"],\n      "steps": [],\n      "taxonomies": ["string"]\n    },\n    {\n      "id": "string",\n      "name": "string",\n      "description": {},\n      "executionType": "MANUAL",\n      "automationConfig": {},\n      "journey": {},\n      "order": 0,\n      "dueDate": "2021-04-27T12:00:00.000Z",\n      "dynamicDueDate": {},\n      "userIds": [0],\n      "requirements": [],\n      "assignedTo": ["string"],\n      "type": "STEP",\n      "ecp": {},\n      "installer": {},\n      "partner": {},\n      "taxonomies": ["string"]\n    }\n  ],\n  "closingReasons": [\n    {\n      "id": "x739cew"\n    }\n  ],\n  "updateEntityAttributes": [\n    {\n      "source": "workflow_status",\n      "target": {}\n    }\n  ],\n  "taxonomies": ["string"],\n  "singleClosingReasonSelection": true,\n  "_manifest": ["string"]\n}\n```\n\n</details>\n\n---\n\n### `listFlowTemplates`\n\nList all Flow Templates for a customer. Optionally, you can filter flow templates by trigger values.\n\n`GET /v2/flows/templates`\n\n```ts\nconst { data } = await client.listFlowTemplates({\n  trigger_type: \'example\',\n  trigger_source_id: \'example\',\n  trigger_schema: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "id": "string",\n      "org_id": "string",\n      "name": "string",\n      "description": "string",\n      "trigger": {},\n      "enabled": true,\n      "version": 2,\n      "created_at": "2021-04-27T12:01:13.000Z",\n      "updated_at": "2021-04-27T12:01:13.000Z",\n      "due_date": "2021-04-27T12:00:00.000Z",\n      "due_date_config": {},\n      "assigned_to": ["string"],\n      "available_in_ecp": true,\n      "additional_triggers": [],\n      "phases": [],\n      "tasks": [],\n      "edges": [],\n      "closing_reasons": [],\n      "entity_sync": [],\n      "taxonomies": ["string"],\n      "singleClosingReasonSelection": true,\n      "_manifest": ["string"],\n      "linear": true,\n      "limit_warnings": []\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `createFlowTemplate`\n\nCreate a new Flow Template (V2 workflow definition).\n\n`POST /v2/flows/templates`\n\n```ts\nconst { data } = await client.createFlowTemplate(\n  {\n    enforce_limits: true,\n  },\n  {\n    id: \'string\',\n    org_id: \'string\',\n    name: \'string\',\n    description: \'string\',\n    trigger: {\n      type: \'automation\',\n      automation_id: \'g92j2-sg9ug92hjt1gh-9s9gajgs-a979gg\'\n    },\n    enabled: true,\n    version: 2,\n    created_at: \'2021-04-27T12:01:13.000Z\',\n    updated_at: \'2021-04-27T12:01:13.000Z\',\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    available_in_ecp: true,\n    additional_triggers: [\n      {\n        id: \'string\',\n        type: \'manual\',\n        entity_schema: \'string\'\n      },\n      {\n        id: \'string\',\n        type: \'automation\',\n        automation_id: \'string\',\n        input_entity: \'thread\',\n        trigger_config: [ /* ... */ ]\n      },\n      /* ... 2 more */\n    ],\n    phases: [\n      {\n        id: \'string\',\n        name: \'string\',\n        due_date: \'2021-04-27T12:00:00.000Z\',\n        due_date_config: { /* ... */ },\n        assigned_to: [\'string\'],\n        taxonomies: [\'string\']\n      }\n    ],\n    tasks: [\n      {\n        id: \'string\',\n        name: \'string\',\n        description: { /* ... */ },\n        journey: { /* ... */ },\n        due_date: \'2021-04-27T12:00:00.000Z\',\n        due_date_config: { /* ... */ },\n        requirements: [ /* ... */ ],\n        assigned_to: [\'string\'],\n        ecp: { /* ... */ },\n        installer: { /* ... */ },\n        partner: { /* ... */ },\n        taxonomies: [\'string\'],\n        phase_id: \'string\',\n        task_type: \'MANUAL\'\n      },\n      {\n        id: \'string\',\n        name: \'string\',\n        description: { /* ... */ },\n        journey: { /* ... */ },\n        due_date: \'2021-04-27T12:00:00.000Z\',\n        due_date_config: { /* ... */ },\n        requirements: [ /* ... */ ],\n        assigned_to: [\'string\'],\n        ecp: { /* ... */ },\n        installer: { /* ... */ },\n        partner: { /* ... */ },\n        taxonomies: [\'string\'],\n        phase_id: \'string\',\n        task_type: \'MANUAL\',\n        automation_config: { /* ... */ },\n        trigger_mode: \'manual\',\n        schedule: { /* ... */ },\n        created_automatically: false\n      },\n      /* ... 2 more */\n    ],\n    edges: [\n      {\n        id: \'string\',\n        from_id: \'string\',\n        to_id: \'string\',\n        condition_id: \'string\',\n        none_met: true\n      }\n    ],\n    closing_reasons: [\n      {\n        id: \'string\',\n        title: \'string\',\n        status: \'ACTIVE\',\n        lastUpdateTime: \'string\',\n        creationTime: \'string\'\n      }\n    ],\n    entity_sync: [\n      {\n        trigger: { /* ... */ },\n        target: { /* ... */ },\n        value: { /* ... */ }\n      }\n    ],\n    taxonomies: [\'string\'],\n    singleClosingReasonSelection: true,\n    _manifest: [\'string\'],\n    linear: true,\n    limit_warnings: [\n      {\n        i18nKey: \'string\',\n        message: \'string\',\n        max: 0,\n        current: 0,\n        node_id: \'string\',\n        task_name: \'string\',\n        branch_name: \'string\',\n        param_name: \'string\',\n        path: [ /* ... */ ]\n      }\n    ]\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "string",\n  "org_id": "string",\n  "name": "string",\n  "description": "string",\n  "trigger": {\n    "type": "automation",\n    "automation_id": "g92j2-sg9ug92hjt1gh-9s9gajgs-a979gg"\n  },\n  "enabled": true,\n  "version": 2,\n  "created_at": "2021-04-27T12:01:13.000Z",\n  "updated_at": "2021-04-27T12:01:13.000Z",\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  "available_in_ecp": true,\n  "additional_triggers": [\n    {\n      "id": "string",\n      "type": "manual",\n      "entity_schema": "string"\n    },\n    {\n      "id": "string",\n      "type": "automation",\n      "automation_id": "string",\n      "input_entity": "thread",\n      "trigger_config": []\n    }\n  ],\n  "phases": [\n    {\n      "id": "string",\n      "name": "string",\n      "due_date": "2021-04-27T12:00:00.000Z",\n      "due_date_config": {},\n      "assigned_to": ["string"],\n      "taxonomies": ["string"]\n    }\n  ],\n  "tasks": [\n    {\n      "id": "string",\n      "name": "string",\n      "description": {},\n      "journey": {},\n      "due_date": "2021-04-27T12:00:00.000Z",\n      "due_date_config": {},\n      "requirements": [],\n      "assigned_to": ["string"],\n      "ecp": {},\n      "installer": {},\n      "partner": {},\n      "taxonomies": ["string"],\n      "phase_id": "string",\n      "task_type": "MANUAL"\n    },\n    {\n      "id": "string",\n      "name": "string",\n      "description": {},\n      "journey": {},\n      "due_date": "2021-04-27T12:00:00.000Z",\n      "due_date_config": {},\n      "requirements": [],\n      "assigned_to": ["string"],\n      "ecp": {},\n      "installer": {},\n      "partner": {},\n      "taxonomies": ["string"],\n      "phase_id": "string",\n      "task_type": "MANUAL",\n      "automation_config": {},\n      "trigger_mode": "manual",\n      "schedule": {},\n      "created_automatically": false\n    }\n  ],\n  "edges": [\n    {\n      "id": "string",\n      "from_id": "string",\n      "to_id": "string",\n      "condition_id": "string",\n      "none_met": true\n    }\n  ],\n  "closing_reasons": [\n    {\n      "id": "string",\n      "title": "string",\n      "status": "ACTIVE",\n      "lastUpdateTime": "string",\n      "creationTime": "string"\n    }\n  ],\n  "entity_sync": [\n    {\n      "trigger": {},\n      "target": {},\n      "value": {}\n    }\n  ],\n  "taxonomies": ["string"],\n  "singleClosingReasonSelection": true,\n  "_manifest": ["string"],\n  "linear": true,\n  "limit_warnings": [\n    {\n      "i18nKey": "string",\n      "message": "string",\n      "max": 0,\n      "current": 0,\n      "node_id": "string",\n      "task_name": "string",\n      "branch_name": "string",\n      "param_name": "string",\n      "path": []\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `searchFlowTemplates`\n\nSearch for flow templates by name, trigger type, enabled status, and more.\n\n`POST /v2/flows/templates:search`\n\n```ts\nconst { data } = await client.searchFlowTemplates(\n  null,\n  {\n    name: \'string\',\n    definition_id: \'string\',\n    trigger_type: \'journey_submission\',\n    enabled: true,\n    from: 0,\n    size: 0,\n    sort_by: \'updated_at\',\n    sort_order: \'desc\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "hits": 0,\n  "results": [\n    {\n      "id": "string",\n      "org_id": "string",\n      "name": "string",\n      "description": "string",\n      "trigger": {},\n      "enabled": true,\n      "version": 2,\n      "created_at": "2021-04-27T12:01:13.000Z",\n      "updated_at": "2021-04-27T12:01:13.000Z",\n      "due_date": "2021-04-27T12:00:00.000Z",\n      "due_date_config": {},\n      "assigned_to": ["string"],\n      "available_in_ecp": true,\n      "additional_triggers": [],\n      "phases": [],\n      "tasks": [],\n      "edges": [],\n      "closing_reasons": [],\n      "entity_sync": [],\n      "taxonomies": ["string"],\n      "singleClosingReasonSelection": true,\n      "_manifest": ["string"],\n      "linear": true,\n      "limit_warnings": []\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `getFlowTemplate`\n\nRetrieve a specific flow template by its unique identifier.\n\n`GET /v2/flows/templates/{flowId}`\n\n```ts\nconst { data } = await client.getFlowTemplate({\n  flowId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "string",\n  "org_id": "string",\n  "name": "string",\n  "description": "string",\n  "trigger": {\n    "type": "automation",\n    "automation_id": "g92j2-sg9ug92hjt1gh-9s9gajgs-a979gg"\n  },\n  "enabled": true,\n  "version": 2,\n  "created_at": "2021-04-27T12:01:13.000Z",\n  "updated_at": "2021-04-27T12:01:13.000Z",\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  "available_in_ecp": true,\n  "additional_triggers": [\n    {\n      "id": "string",\n      "type": "manual",\n      "entity_schema": "string"\n    },\n    {\n      "id": "string",\n      "type": "automation",\n      "automation_id": "string",\n      "input_entity": "thread",\n      "trigger_config": []\n    }\n  ],\n  "phases": [\n    {\n      "id": "string",\n      "name": "string",\n      "due_date": "2021-04-27T12:00:00.000Z",\n      "due_date_config": {},\n      "assigned_to": ["string"],\n      "taxonomies": ["string"]\n    }\n  ],\n  "tasks": [\n    {\n      "id": "string",\n      "name": "string",\n      "description": {},\n      "journey": {},\n      "due_date": "2021-04-27T12:00:00.000Z",\n      "due_date_config": {},\n      "requirements": [],\n      "assigned_to": ["string"],\n      "ecp": {},\n      "installer": {},\n      "partner": {},\n      "taxonomies": ["string"],\n      "phase_id": "string",\n      "task_type": "MANUAL"\n    },\n    {\n      "id": "string",\n      "name": "string",\n      "description": {},\n      "journey": {},\n      "due_date": "2021-04-27T12:00:00.000Z",\n      "due_date_config": {},\n      "requirements": [],\n      "assigned_to": ["string"],\n      "ecp": {},\n      "installer": {},\n      "partner": {},\n      "taxonomies": ["string"],\n      "phase_id": "string",\n      "task_type": "MANUAL",\n      "automation_config": {},\n      "trigger_mode": "manual",\n      "schedule": {},\n      "created_automatically": false\n    }\n  ],\n  "edges": [\n    {\n      "id": "string",\n      "from_id": "string",\n      "to_id": "string",\n      "condition_id": "string",\n      "none_met": true\n    }\n  ],\n  "closing_reasons": [\n    {\n      "id": "string",\n      "title": "string",\n      "status": "ACTIVE",\n      "lastUpdateTime": "string",\n      "creationTime": "string"\n    }\n  ],\n  "entity_sync": [\n    {\n      "trigger": {},\n      "target": {},\n      "value": {}\n    }\n  ],\n  "taxonomies": ["string"],\n  "singleClosingReasonSelection": true,\n  "_manifest": ["string"],\n  "linear": true,\n  "limit_warnings": [\n    {\n      "i18nKey": "string",\n      "message": "string",\n      "max": 0,\n      "current": 0,\n      "node_id": "string",\n      "task_name": "string",\n      "branch_name": "string",\n      "param_name": "string",\n      "path": []\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `updateFlowTemplate`\n\nUpdate Flow Template.\n\n`PUT /v2/flows/templates/{flowId}`\n\n```ts\nconst { data } = await client.updateFlowTemplate(\n  {\n    flowId: \'example\',\n    enforce_limits: true,\n  },\n  {\n    id: \'string\',\n    org_id: \'string\',\n    name: \'string\',\n    description: \'string\',\n    trigger: {\n      type: \'automation\',\n      automation_id: \'g92j2-sg9ug92hjt1gh-9s9gajgs-a979gg\'\n    },\n    enabled: true,\n    version: 2,\n    created_at: \'2021-04-27T12:01:13.000Z\',\n    updated_at: \'2021-04-27T12:01:13.000Z\',\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    available_in_ecp: true,\n    additional_triggers: [\n      {\n        id: \'string\',\n        type: \'manual\',\n        entity_schema: \'string\'\n      },\n      {\n        id: \'string\',\n        type: \'automation\',\n        automation_id: \'string\',\n        input_entity: \'thread\',\n        trigger_config: [ /* ... */ ]\n      },\n      /* ... 2 more */\n    ],\n    phases: [\n      {\n        id: \'string\',\n        name: \'string\',\n        due_date: \'2021-04-27T12:00:00.000Z\',\n        due_date_config: { /* ... */ },\n        assigned_to: [\'string\'],\n        taxonomies: [\'string\']\n      }\n    ],\n    tasks: [\n      {\n        id: \'string\',\n        name: \'string\',\n        description: { /* ... */ },\n        journey: { /* ... */ },\n        due_date: \'2021-04-27T12:00:00.000Z\',\n        due_date_config: { /* ... */ },\n        requirements: [ /* ... */ ],\n        assigned_to: [\'string\'],\n        ecp: { /* ... */ },\n        installer: { /* ... */ },\n        partner: { /* ... */ },\n        taxonomies: [\'string\'],\n        phase_id: \'string\',\n        task_type: \'MANUAL\'\n      },\n      {\n        id: \'string\',\n        name: \'string\',\n        description: { /* ... */ },\n        journey: { /* ... */ },\n        due_date: \'2021-04-27T12:00:00.000Z\',\n        due_date_config: { /* ... */ },\n        requirements: [ /* ... */ ],\n        assigned_to: [\'string\'],\n        ecp: { /* ... */ },\n        installer: { /* ... */ },\n        partner: { /* ... */ },\n        taxonomies: [\'string\'],\n        phase_id: \'string\',\n        task_type: \'MANUAL\',\n        automation_config: { /* ... */ },\n        trigger_mode: \'manual\',\n        schedule: { /* ... */ },\n        created_automatically: false\n      },\n      /* ... 2 more */\n    ],\n    edges: [\n      {\n        id: \'string\',\n        from_id: \'string\',\n        to_id: \'string\',\n        condition_id: \'string\',\n        none_met: true\n      }\n    ],\n    closing_reasons: [\n      {\n        id: \'string\',\n        title: \'string\',\n        status: \'ACTIVE\',\n        lastUpdateTime: \'string\',\n        creationTime: \'string\'\n      }\n    ],\n    entity_sync: [\n      {\n        trigger: { /* ... */ },\n        target: { /* ... */ },\n        value: { /* ... */ }\n      }\n    ],\n    taxonomies: [\'string\'],\n    singleClosingReasonSelection: true,\n    _manifest: [\'string\'],\n    linear: true,\n    limit_warnings: [\n      {\n        i18nKey: \'string\',\n        message: \'string\',\n        max: 0,\n        current: 0,\n        node_id: \'string\',\n        task_name: \'string\',\n        branch_name: \'string\',\n        param_name: \'string\',\n        path: [ /* ... */ ]\n      }\n    ]\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "string",\n  "org_id": "string",\n  "name": "string",\n  "description": "string",\n  "trigger": {\n    "type": "automation",\n    "automation_id": "g92j2-sg9ug92hjt1gh-9s9gajgs-a979gg"\n  },\n  "enabled": true,\n  "version": 2,\n  "created_at": "2021-04-27T12:01:13.000Z",\n  "updated_at": "2021-04-27T12:01:13.000Z",\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  "available_in_ecp": true,\n  "additional_triggers": [\n    {\n      "id": "string",\n      "type": "manual",\n      "entity_schema": "string"\n    },\n    {\n      "id": "string",\n      "type": "automation",\n      "automation_id": "string",\n      "input_entity": "thread",\n      "trigger_config": []\n    }\n  ],\n  "phases": [\n    {\n      "id": "string",\n      "name": "string",\n      "due_date": "2021-04-27T12:00:00.000Z",\n      "due_date_config": {},\n      "assigned_to": ["string"],\n      "taxonomies": ["string"]\n    }\n  ],\n  "tasks": [\n    {\n      "id": "string",\n      "name": "string",\n      "description": {},\n      "journey": {},\n      "due_date": "2021-04-27T12:00:00.000Z",\n      "due_date_config": {},\n      "requirements": [],\n      "assigned_to": ["string"],\n      "ecp": {},\n      "installer": {},\n      "partner": {},\n      "taxonomies": ["string"],\n      "phase_id": "string",\n      "task_type": "MANUAL"\n    },\n    {\n      "id": "string",\n      "name": "string",\n      "description": {},\n      "journey": {},\n      "due_date": "2021-04-27T12:00:00.000Z",\n      "due_date_config": {},\n      "requirements": [],\n      "assigned_to": ["string"],\n      "ecp": {},\n      "installer": {},\n      "partner": {},\n      "taxonomies": ["string"],\n      "phase_id": "string",\n      "task_type": "MANUAL",\n      "automation_config": {},\n      "trigger_mode": "manual",\n      "schedule": {},\n      "created_automatically": false\n    }\n  ],\n  "edges": [\n    {\n      "id": "string",\n      "from_id": "string",\n      "to_id": "string",\n      "condition_id": "string",\n      "none_met": true\n    }\n  ],\n  "closing_reasons": [\n    {\n      "id": "string",\n      "title": "string",\n      "status": "ACTIVE",\n      "lastUpdateTime": "string",\n      "creationTime": "string"\n    }\n  ],\n  "entity_sync": [\n    {\n      "trigger": {},\n      "target": {},\n      "value": {}\n    }\n  ],\n  "taxonomies": ["string"],\n  "singleClosingReasonSelection": true,\n  "_manifest": ["string"],\n  "linear": true,\n  "limit_warnings": [\n    {\n      "i18nKey": "string",\n      "message": "string",\n      "max": 0,\n      "current": 0,\n      "node_id": "string",\n      "task_name": "string",\n      "branch_name": "string",\n      "param_name": "string",\n      "path": []\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `deleteFlowTemplate`\n\nDelete Flow Template.\n\n`DELETE /v2/flows/templates/{flowId}`\n\n```ts\nconst { data } = await client.deleteFlowTemplate({\n  flowId: \'example\',\n})\n```\n\n---\n\n### `duplicateFlowTemplate`\n\nCreate a copy of an existing flow template. The duplicated template will have a new\nunique identifier and can be modified independently of the original. This is useful\nfor creating variations of exist\n\n`POST /v2/flows/templates/{flowId}/duplicate`\n\n```ts\nconst { data } = await client.duplicateFlowTemplate({\n  flowId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "string",\n  "org_id": "string",\n  "name": "string",\n  "description": "string",\n  "trigger": {\n    "type": "automation",\n    "automation_id": "g92j2-sg9ug92hjt1gh-9s9gajgs-a979gg"\n  },\n  "enabled": true,\n  "version": 2,\n  "created_at": "2021-04-27T12:01:13.000Z",\n  "updated_at": "2021-04-27T12:01:13.000Z",\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  "available_in_ecp": true,\n  "additional_triggers": [\n    {\n      "id": "string",\n      "type": "manual",\n      "entity_schema": "string"\n    },\n    {\n      "id": "string",\n      "type": "automation",\n      "automation_id": "string",\n      "input_entity": "thread",\n      "trigger_config": []\n    }\n  ],\n  "phases": [\n    {\n      "id": "string",\n      "name": "string",\n      "due_date": "2021-04-27T12:00:00.000Z",\n      "due_date_config": {},\n      "assigned_to": ["string"],\n      "taxonomies": ["string"]\n    }\n  ],\n  "tasks": [\n    {\n      "id": "string",\n      "name": "string",\n      "description": {},\n      "journey": {},\n      "due_date": "2021-04-27T12:00:00.000Z",\n      "due_date_config": {},\n      "requirements": [],\n      "assigned_to": ["string"],\n      "ecp": {},\n      "installer": {},\n      "partner": {},\n      "taxonomies": ["string"],\n      "phase_id": "string",\n      "task_type": "MANUAL"\n    },\n    {\n      "id": "string",\n      "name": "string",\n      "description": {},\n      "journey": {},\n      "due_date": "2021-04-27T12:00:00.000Z",\n      "due_date_config": {},\n      "requirements": [],\n      "assigned_to": ["string"],\n      "ecp": {},\n      "installer": {},\n      "partner": {},\n      "taxonomies": ["string"],\n      "phase_id": "string",\n      "task_type": "MANUAL",\n      "automation_config": {},\n      "trigger_mode": "manual",\n      "schedule": {},\n      "created_automatically": false\n    }\n  ],\n  "edges": [\n    {\n      "id": "string",\n      "from_id": "string",\n      "to_id": "string",\n      "condition_id": "string",\n      "none_met": true\n    }\n  ],\n  "closing_reasons": [\n    {\n      "id": "string",\n      "title": "string",\n      "status": "ACTIVE",\n      "lastUpdateTime": "string",\n      "creationTime": "string"\n    }\n  ],\n  "entity_sync": [\n    {\n      "trigger": {},\n      "target": {},\n      "value": {}\n    }\n  ],\n  "taxonomies": ["string"],\n  "singleClosingReasonSelection": true,\n  "_manifest": ["string"],\n  "linear": true,\n  "limit_warnings": [\n    {\n      "i18nKey": "string",\n      "message": "string",\n      "max": 0,\n      "current": 0,\n      "node_id": "string",\n      "task_name": "string",\n      "branch_name": "string",\n      "param_name": "string",\n      "path": []\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `getDefinition`\n\nGet specific Definition by id from the Organization.\n\n`GET /v1/workflows/definitions/{definitionId}`\n\n```ts\nconst { data } = await client.getDefinition({\n  definitionId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "string",\n  "name": "string",\n  "description": "string",\n  "creationTime": "2021-04-27T12:01:13.000Z",\n  "enabled": true,\n  "lastUpdateTime": "2021-04-27T12:01:13.000Z",\n  "dueDate": "2021-04-27T12:00:00.000Z",\n  "dynamicDueDate": {\n    "numberOfUnits": 0,\n    "timePeriod": "minutes",\n    "actionTypeCondition": "WORKFLOW_STARTED",\n    "stepId": "string",\n    "phaseId": "string"\n  },\n  "userIds": [0],\n  "assignedTo": ["string"],\n  "enableECPWorkflow": true,\n  "flow": [\n    {\n      "id": "string",\n      "name": "string",\n      "order": 0,\n      "type": "STEP",\n      "dueDate": "2021-04-27T12:00:00.000Z",\n      "dynamicDueDate": {},\n      "assignedTo": ["string"],\n      "steps": [],\n      "taxonomies": ["string"]\n    },\n    {\n      "id": "string",\n      "name": "string",\n      "description": {},\n      "executionType": "MANUAL",\n      "automationConfig": {},\n      "journey": {},\n      "order": 0,\n      "dueDate": "2021-04-27T12:00:00.000Z",\n      "dynamicDueDate": {},\n      "userIds": [0],\n      "requirements": [],\n      "assignedTo": ["string"],\n      "type": "STEP",\n      "ecp": {},\n      "installer": {},\n      "partner": {},\n      "taxonomies": ["string"]\n    }\n  ],\n  "closingReasons": [\n    {\n      "id": "x739cew"\n    }\n  ],\n  "updateEntityAttributes": [\n    {\n      "source": "workflow_status",\n      "target": {}\n    }\n  ],\n  "taxonomies": ["string"],\n  "singleClosingReasonSelection": true,\n  "_manifest": ["string"]\n}\n```\n\n</details>\n\n---\n\n### `updateDefinition`\n\nUpdate Workflow Definition.\n\n`PUT /v1/workflows/definitions/{definitionId}`\n\n```ts\nconst { data } = await client.updateDefinition(\n  {\n    definitionId: \'example\',\n  },\n  {\n    id: \'string\',\n    name: \'string\',\n    description: \'string\',\n    creationTime: \'2021-04-27T12:01:13.000Z\',\n    enabled: true,\n    lastUpdateTime: \'2021-04-27T12:01:13.000Z\',\n    dueDate: \'2021-04-27T12:00:00.000Z\',\n    dynamicDueDate: {\n      numberOfUnits: 0,\n      timePeriod: \'minutes\',\n      actionTypeCondition: \'WORKFLOW_STARTED\',\n      stepId: \'string\',\n      phaseId: \'string\'\n    },\n    userIds: [0],\n    assignedTo: [\'string\'],\n    enableECPWorkflow: true,\n    flow: [\n      {\n        id: \'string\',\n        name: \'string\',\n        order: 0,\n        type: \'STEP\',\n        dueDate: \'2021-04-27T12:00:00.000Z\',\n        dynamicDueDate: { /* ... */ },\n        assignedTo: [\'string\'],\n        steps: [ /* ... */ ],\n        taxonomies: [\'string\']\n      },\n      {\n        id: \'string\',\n        name: \'string\',\n        description: { /* ... */ },\n        executionType: \'MANUAL\',\n        automationConfig: { /* ... */ },\n        journey: { /* ... */ },\n        order: 0,\n        dueDate: \'2021-04-27T12:00:00.000Z\',\n        dynamicDueDate: { /* ... */ },\n        userIds: [0],\n        requirements: [ /* ... */ ],\n        assignedTo: [\'string\'],\n        type: \'STEP\',\n        ecp: { /* ... */ },\n        installer: { /* ... */ },\n        partner: { /* ... */ },\n        taxonomies: [\'string\']\n      }\n    ],\n    closingReasons: [\n      {\n        id: \'x739cew\'\n      }\n    ],\n    updateEntityAttributes: [\n      {\n        source: \'workflow_status\',\n        target: { /* ... */ }\n      }\n    ],\n    taxonomies: [\'string\'],\n    singleClosingReasonSelection: true,\n    _manifest: [\'string\']\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "string",\n  "name": "string",\n  "description": "string",\n  "creationTime": "2021-04-27T12:01:13.000Z",\n  "enabled": true,\n  "lastUpdateTime": "2021-04-27T12:01:13.000Z",\n  "dueDate": "2021-04-27T12:00:00.000Z",\n  "dynamicDueDate": {\n    "numberOfUnits": 0,\n    "timePeriod": "minutes",\n    "actionTypeCondition": "WORKFLOW_STARTED",\n    "stepId": "string",\n    "phaseId": "string"\n  },\n  "userIds": [0],\n  "assignedTo": ["string"],\n  "enableECPWorkflow": true,\n  "flow": [\n    {\n      "id": "string",\n      "name": "string",\n      "order": 0,\n      "type": "STEP",\n      "dueDate": "2021-04-27T12:00:00.000Z",\n      "dynamicDueDate": {},\n      "assignedTo": ["string"],\n      "steps": [],\n      "taxonomies": ["string"]\n    },\n    {\n      "id": "string",\n      "name": "string",\n      "description": {},\n      "executionType": "MANUAL",\n      "automationConfig": {},\n      "journey": {},\n      "order": 0,\n      "dueDate": "2021-04-27T12:00:00.000Z",\n      "dynamicDueDate": {},\n      "userIds": [0],\n      "requirements": [],\n      "assignedTo": ["string"],\n      "type": "STEP",\n      "ecp": {},\n      "installer": {},\n      "partner": {},\n      "taxonomies": ["string"]\n    }\n  ],\n  "closingReasons": [\n    {\n      "id": "x739cew"\n    }\n  ],\n  "updateEntityAttributes": [\n    {\n      "source": "workflow_status",\n      "target": {}\n    }\n  ],\n  "taxonomies": ["string"],\n  "singleClosingReasonSelection": true,\n  "_manifest": ["string"]\n}\n```\n\n</details>\n\n---\n\n### `deleteDefinition`\n\nDelete Workflow Definition.\n\n`DELETE /v1/workflows/definitions/{definitionId}`\n\n```ts\nconst { data } = await client.deleteDefinition({\n  definitionId: \'example\',\n})\n```\n\n---\n\n### `getAllClosingReasons`\n\nGet all Closing Reasons defined in the organization by default all Active.\n\n`GET /v1/workflows/closing-reasons`\n\n```ts\nconst { data } = await client.getAllClosingReasons({\n  includeInactive: true,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "reasons": [\n    {\n      "id": "string",\n      "title": "string",\n      "status": "ACTIVE",\n      "lastUpdateTime": "string",\n      "creationTime": "string"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `createClosingReason`\n\nA created Closing Reason is stored for the organization and will be displayed in the library of reasons.\n\n`POST /v1/workflows/closing-reasons`\n\n```ts\nconst { data } = await client.createClosingReason(\n  null,\n  {\n    id: \'string\',\n    title: \'string\',\n    status: \'ACTIVE\',\n    lastUpdateTime: \'string\',\n    creationTime: \'string\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "string",\n  "title": "string",\n  "status": "ACTIVE",\n  "lastUpdateTime": "string",\n  "creationTime": "string"\n}\n```\n\n</details>\n\n---\n\n### `getClosingReason`\n\nGet specific closing reason by id from the organisation.\n\n`GET /v2/workflows/closing-reasons/{reasonId}`\n\n```ts\nconst { data } = await client.getClosingReason({\n  reasonId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "string",\n  "title": "string",\n  "status": "ACTIVE",\n  "lastUpdateTime": "string",\n  "creationTime": "string"\n}\n```\n\n</details>\n\n---\n\n### `updateClosingReason`\n\nUpdate an existing closing reason\n\n`PATCH /v2/workflows/closing-reasons/{reasonId}`\n\n```ts\nconst { data } = await client.updateClosingReason(\n  {\n    reasonId: \'example\',\n  },\n  {\n    id: \'string\',\n    title: \'string\',\n    status: \'ACTIVE\',\n    lastUpdateTime: \'string\',\n    creationTime: \'string\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "string",\n  "title": "string",\n  "status": "ACTIVE",\n  "lastUpdateTime": "string",\n  "creationTime": "string"\n}\n```\n\n</details>\n\n---\n\n### `deleteClosingReason`\n\nPermanently delete a closing reason (Using INACTIVE status is recommended instead)\n\n`DELETE /v2/workflows/closing-reasons/{reasonId}`\n\n```ts\nconst { data } = await client.deleteClosingReason({\n  reasonId: \'example\',\n})\n```\n\n---\n\n### `changeReasonStatus`\n\nChange the status of a Closing Reason (eg. ACTIVE to INACTIVE).\n\n`PATCH /v1/workflows/closing-reasons/{reasonId}`\n\n```ts\nconst { data } = await client.changeReasonStatus(\n  {\n    reasonId: \'example\',\n  },\n  {\n    status: \'ACTIVE\'\n  },\n)\n```\n\n---\n\n### `getWorkflowClosingReasons`\n\nReturns all closing reasons defined for the workflow.\n\n`GET /v1/workflows/definitions/{definitionId}/closing-reasons`\n\n```ts\nconst { data } = await client.getWorkflowClosingReasons({\n  definitionId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "reasons": [\n    {\n      "id": "x739cew"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `setWorkflowClosingReasons`\n\nSets which closing reasons are defined for this workflow, based on the entire closing reasons catalog.\n\n`PATCH /v1/workflows/definitions/{definitionId}/closing-reasons`\n\n```ts\nconst { data } = await client.setWorkflowClosingReasons(\n  {\n    definitionId: \'example\',\n  },\n  {\n    reasons: [\n      {\n        id: \'x739cew\'\n      }\n    ]\n  },\n)\n```\n\n---\n\n## Schemas\n\n### `FlowTemplateBase`\n\nBase schema for V2 flow templates. A flow template defines the structure of a workflow\nincluding phases, tasks, edges, triggers, and other configuration. Flow templates serve\nas blueprints that can be instantiated as flow executions.\n\n\n```ts\ntype FlowTemplateBase = {\n  id?: string\n  org_id?: string\n  name: string\n  description?: string\n  trigger?: {\n    id?: string\n    type: "manual"\n    entity_schema?: string\n  } | {\n    id?: string\n    type: "automation"\n    automation_id?: string\n    input_entity?: "thread" | "first_email" | "last_email"\n    trigger_config?: Array<{\n      type: { ... }\n      configuration?: { ... }\n    }>\n  } | {\n    id?: string\n    type: "journey_submission"\n    journey_id: string\n    journey_name?: string\n    automation_id?: string\n  } | {\n    id?: string\n    type: "journey_automation"\n    entity_schema?: string\n  }\n  enabled?: boolean\n  version?: "v1" | "v2" | "v3"\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" | "years"\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  available_in_ecp?: boolean\n  additional_triggers?: Array<{\n    id?: string\n    type: "manual"\n    entity_schema?: string\n  } | {\n    id?: string\n    type: "automation"\n    automation_id?: string\n    input_entity?: "thread" | "first_email" | "last_email"\n    trigger_config?: Array<{\n      type: { ... }\n      configuration?: { ... }\n    }>\n  } | {\n    id?: string\n    type: "journey_submission"\n    journey_id: string\n    journey_name?: string\n    automation_id?: string\n  } | {\n    id?: string\n    type: "journey_automation"\n    entity_schema?: string\n  }>\n  phases?: Array<{\n    id: string\n    name: 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    taxonomies?: string[]\n  }>\n  tasks: Array<{\n    id: string\n    name: string\n    description?: {\n      enabled?: { ... }\n      value?: { ... }\n    }\n    journey?: {\n      id?: { ... }\n      journeyId?: { ... }\n      name?: { ... }\n      complete_task_automatically?: { ... }\n    }\n  // ...\n}\n```\n\n### `FlowLimitWarning`\n\nA configuration limit that the flow currently exceeds. Returned by the get-flow endpoint and by create/update responses so the UI can show a non-blocking banner. Size/count limit violations never cause a 400 \u2014 only structural errors do. The flow remains fully usable; users are encouraged to bring va\n\n```ts\ntype FlowLimitWarning = {\n  i18nKey: string\n  message: string\n  max: number\n  current?: number\n  node_id?: string\n  task_name?: string\n  branch_name?: string\n  param_name?: string\n  path: unknown[]\n}\n```\n\n### `FlowTemplate`\n\n```ts\ntype FlowTemplate = {\n  id?: string\n  org_id?: string\n  name: string\n  description?: string\n  trigger?: {\n    id?: string\n    type: "manual"\n    entity_schema?: string\n  } | {\n    id?: string\n    type: "automation"\n    automation_id?: string\n    input_entity?: "thread" | "first_email" | "last_email"\n    trigger_config?: Array<{\n      type: { ... }\n      configuration?: { ... }\n    }>\n  } | {\n    id?: string\n    type: "journey_submission"\n    journey_id: string\n    journey_name?: string\n    automation_id?: string\n  } | {\n    id?: string\n    type: "journey_automation"\n    entity_schema?: string\n  }\n  enabled?: boolean\n  version?: "v1" | "v2" | "v3"\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" | "years"\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  available_in_ecp?: boolean\n  additional_triggers?: Array<{\n    id?: string\n    type: "manual"\n    entity_schema?: string\n  } | {\n    id?: string\n    type: "automation"\n    automation_id?: string\n    input_entity?: "thread" | "first_email" | "last_email"\n    trigger_config?: Array<{\n      type: { ... }\n      configuration?: { ... }\n    }>\n  } | {\n    id?: string\n    type: "journey_submission"\n    journey_id: string\n    journey_name?: string\n    automation_id?: string\n  } | {\n    id?: string\n    type: "journey_automation"\n    entity_schema?: string\n  }>\n  phases?: Array<{\n    id: string\n    name: 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    taxonomies?: string[]\n  }>\n  tasks: Array<{\n    id: string\n    name: string\n    description?: {\n      enabled?: { ... }\n      value?: { ... }\n    }\n    journey?: {\n      id?: { ... }\n      journeyId?: { ... }\n      name?: { ... }\n      complete_task_automatically?: { ... }\n    }\n  // ...\n}\n```\n\n### `Version`\n\nVersion of the workflow schema.\n\n- `v1` \u2013 *Deprecated*. The initial version of workflows with limited structure and automation capabilities.\n- `v2` \u2013 Linear workflows. Supports sequential task execution with basic automation triggers.\n- `v3` \u2013 Advanced workflows. Adds support for branching logic (co\n\n```ts\ntype Version = "v1" | "v2" | "v3"\n```\n\n### `Trigger`\n\n```ts\ntype Trigger = {\n  id?: string\n  type: "manual"\n  entity_schema?: string\n} | {\n  id?: string\n  type: "automation"\n  automation_id?: string\n  input_entity?: "thread" | "first_email" | "last_email"\n  trigger_config?: Array<{\n    type: string\n    configuration?: Record<string, unknown>\n  }>\n} | {\n  id?: string\n  type: "journey_submission"\n  journey_id: string\n  journey_name?: string\n  automation_id?: string\n} | {\n  id?: string\n  type: "journey_automation"\n  entity_schema?: string\n}\n```\n\n### `ManualTrigger`\n\n```ts\ntype ManualTrigger = {\n  id?: string\n  type: "manual"\n  entity_schema?: string\n}\n```\n\n### `AutomationTrigger`\n\n```ts\ntype AutomationTrigger = {\n  id?: string\n  type: "automation"\n  automation_id?: string\n  input_entity?: "thread" | "first_email" | "last_email"\n  trigger_config?: Array<{\n    type: string\n    configuration?: Record<string, unknown>\n  }>\n}\n```\n\n### `JourneyAutomationTrigger`\n\n```ts\ntype JourneyAutomationTrigger = {\n  id?: string\n  type: "journey_automation"\n  entity_schema?: string\n}\n```\n\n### `JourneySubmissionTrigger`\n\n```ts\ntype JourneySubmissionTrigger = {\n  id?: string\n  type: "journey_submission"\n  journey_id: string\n  journey_name?: string\n  automation_id?: string\n}\n```\n\n### `CreateFlowTemplate`\n\n```ts\ntype CreateFlowTemplate = {\n  id?: string\n  org_id?: string\n  name: string\n  description?: string\n  trigger?: {\n    id?: string\n    type: "manual"\n    entity_schema?: string\n  } | {\n    id?: string\n    type: "automation"\n    automation_id?: string\n    input_entity?: "thread" | "first_email" | "last_email"\n    trigger_config?: Array<{\n      type: { ... }\n      configuration?: { ... }\n    }>\n  } | {\n    id?: string\n    type: "journey_submission"\n    journey_id: string\n    journey_name?: string\n    automation_id?: string\n  } | {\n    id?: string\n    type: "journey_automation"\n    entity_schema?: string\n  }\n  enabled?: boolean\n  version?: "v1" | "v2" | "v3"\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" | "years"\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  available_in_ecp?: boolean\n  additional_triggers?: Array<{\n    id?: string\n    type: "manual"\n    entity_schema?: string\n  } | {\n    id?: string\n    type: "automation"\n    automation_id?: string\n    input_entity?: "thread" | "first_email" | "last_email"\n    trigger_config?: Array<{\n      type: { ... }\n      configuration?: { ... }\n    }>\n  } | {\n    id?: string\n    type: "journey_submission"\n    journey_id: string\n    journey_name?: string\n    automation_id?: string\n  } | {\n    id?: string\n    type: "journey_automation"\n    entity_schema?: string\n  }>\n  phases?: Array<{\n    id: string\n    name: 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    taxonomies?: string[]\n  }>\n  tasks: Array<{\n    id: string\n    name: string\n    description?: {\n      enabled?: { ... }\n      value?: { ... }\n    }\n    journey?: {\n      id?: { ... }\n      journeyId?: { ... }\n      name?: { ... }\n      complete_task_automatically?: { ... }\n    }\n  // ...\n}\n```\n\n### `SearchFlowTemplates`\n\n```ts\ntype SearchFlowTemplates = {\n  name?: string\n  definition_id?: string\n  trigger_type?: "journey_submission" | "manual" | "automation"\n  enabled?: boolean\n  from?: number\n  size?: number\n  sort_by?: "created_at" | "updated_at"\n  sort_order?: "asc" | "desc"\n}\n```\n\n### `FlowTemplatesList`\n\n```ts\ntype FlowTemplatesList = {\n  results: Array<{\n    id?: string\n    org_id?: string\n    name: string\n    description?: string\n    trigger?: {\n      id?: { ... }\n      type: { ... }\n      entity_schema?: { ... }\n    } | {\n      id?: { ... }\n      type: { ... }\n      automation_id?: { ... }\n      input_entity?: { ... }\n      trigger_config?: { ... }\n    } | {\n      id?: { ... }\n      type: { ... }\n      journey_id: { ... }\n      journey_name?: { ... }\n      automation_id?: { ... }\n    } | {\n      id?: { ... }\n      type: { ... }\n      entity_schema?: { ... }\n    }\n    enabled?: boolean\n    version?: "v1" | "v2" | "v3"\n    created_at?: string\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    available_in_ecp?: boolean\n    additional_triggers?: Array<{\n      id?: { ... }\n      type: { ... }\n      entity_schema?: { ... }\n    } | {\n      id?: { ... }\n      type: { ... }\n      automation_id?: { ... }\n      input_entity?: { ... }\n      trigger_config?: { ... }\n    } | {\n      id?: { ... }\n      type: { ... }\n      journey_id: { ... }\n      journey_name?: { ... }\n      automation_id?: { ... }\n    } | {\n      id?: { ... }\n      type: { ... }\n      entity_schema?: { ... }\n    }>\n    phases?: Array<{\n      id: { ... }\n      name: { ... }\n      due_date?: { ... }\n      due_date_config?: { ... }\n      assigned_to?: { ... }\n      taxonomies?: { ... }\n    }>\n    tasks: Array<{\n      id: { ... }\n      name: { ... }\n      description?: { ... }\n      journey?: { ... }\n      due_date?: { ... }\n      due_date_config?: { ... }\n      requirements?: { ... }\n      assigned_to?: { ... }\n      ecp?: { ... }\n      installer?: { ... }\n      partner?: { ... }\n      taxonomies?: { ... }\n      phase_id?: { ... }\n      task_type: { ... }\n    } | {\n      id: { ... }\n      name: { ... }\n      description?: { ... }\n      journey?: { ... }\n      due_date?: { ... }\n      due_date_config?: { ... }\n      requirements?: { ... }\n      assigned_to?: { ... }\n      ecp?: { ... }\n      installer?: { ... }\n      partner?: { ... }\n  // ...\n}\n```\n\n### `FlowTemplateId`\n\nShort unique id (length 8) to identify the Flow Template.\n\n```ts\ntype FlowTemplateId = string\n```\n\n### `Task`\n\n```ts\ntype Task = {\n  id: string\n  name: string\n  description?: {\n    enabled?: boolean\n    value?: string\n  }\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" | "years"\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  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  partner?: {\n    enabled?: boolean\n    label?: string\n    description?: string\n  }\n  taxonomies?: string[]\n  phase_id?: string\n  task_type: "MANUAL" | "AUTOMATION" | "DECISION" | "AI_AGENT"\n} | {\n  id: string\n  name: string\n  description?: {\n    enabled?: boolean\n    value?: string\n  }\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" | "years"\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  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}\n```\n\n### `ManualTask`\n\n```ts\ntype ManualTask = {\n  id: string\n  name: string\n  description?: {\n    enabled?: boolean\n    value?: string\n  }\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" | "years"\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  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  partner?: {\n    enabled?: boolean\n    label?: string\n    description?: string\n  }\n  taxonomies?: string[]\n  phase_id?: string\n  task_type: "MANUAL" | "AUTOMATION" | "DECISION" | "AI_AGENT"\n}\n```\n\n### `AutomationTask`\n\n```ts\ntype AutomationTask = {\n  id: string\n  name: string\n  description?: {\n    enabled?: boolean\n    value?: string\n  }\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" | "years"\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  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  partner?: {\n    enabled?: boolean\n    label?: string\n    description?: string\n  }\n  taxonomies?: string[]\n  phase_id?: string\n  task_type: "MANUAL" | "AUTOMATION" | "DECISION" | "AI_AGENT"\n  automation_config: {\n    flow_id?: string\n    action_config?: {\n      type: { ... }\n      config?: { ... }\n    }\n    duplicated_flow_id?: string\n    input_context?: {\n      source: { ... }\n      task_id?: { ... }\n    }\n  }\n  trigger_mode?: "manual" | "automatic"\n  schedule?: {\n    mode?: "immediate"\n  } | {\n    mode: "delayed"\n    duration: number\n    unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"\n  } | {\n    mode: "relative"\n    direction: "before" | "after"\n    duration: number\n    unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"\n    reference: {\n      id: { ... }\n      origin: { ... }\n      schema?: { ... }\n      attribute?: { ... }\n    }\n  }\n  created_automatically?: boolean\n}\n```\n\n### `AutomationConfig`\n\nConfiguration for automation execution to run\n\n```ts\ntype AutomationConfig = {\n  flow_id?: string\n  action_config?: {\n    type: string\n    config?: Record<string, unknown>\n  }\n  duplicated_flow_id?: string\n  input_context?: {\n    source: "trigger" | "task"\n    task_id?: string\n  }\n}\n```\n\n### `AutomationInputContext`\n\nOptional. Source of the entity fed into this automation task. If omitted, the workflow\'s primary entity is used.\n\n\n```ts\ntype AutomationInputContext = {\n  source: "trigger" | "task"\n  task_id?: string\n}\n```\n\n### `AiAgentTask`\n\n```ts\ntype AiAgentTask = {\n  id: string\n  name: string\n  description?: {\n    enabled?: boolean\n    value?: string\n  }\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" | "years"\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  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  partner?: {\n    enabled?: boolean\n    label?: string\n    description?: string\n  }\n  taxonomies?: string[]\n  phase_id?: string\n  task_type: "MANUAL" | "AUTOMATION" | "DECISION" | "AI_AGENT"\n  agent_config?: {\n    agent_id: string\n  }\n}\n```\n\n### `AgentConfig`\n\nConfiguration for AI Agent to run\n\n```ts\ntype AgentConfig = {\n  agent_id: string\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" | "years"\n} | {\n  mode: "relative"\n  direction: "before" | "after"\n  duration: number\n  unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"\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}\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" | "years"\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" | "years"\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}\n```\n\n### `DecisionTask`\n\n```ts\ntype DecisionTask = {\n  id: string\n  name: string\n  description?: {\n    enabled?: boolean\n    value?: string\n  }\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" | "years"\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  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  partner?: {\n    enabled?: boolean\n    label?: string\n    description?: string\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  }>\n  allow_parallel_execution?: boolean\n  schedule?: {\n    mode: "delayed"\n    duration: number\n    unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"\n  } | {\n    mode: "relative"\n    direction: "before" | "after"\n    duration: number\n    unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"\n    reference: {\n      id: { ... }\n      origin: { ... }\n      schema?: { ... }\n      attribute?: { ... }\n    }\n  }\n  loop_config?: {\n    loop_branch_id: string\n    exit_branch_id: string\n    max_iterations: number\n  }\n}\n```\n\n### `TaskBase`\n\n```ts\ntype TaskBase = {\n  id: string\n  name: string\n  description?: {\n    enabled?: boolean\n    value?: string\n  }\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" | "years"\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  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  partner?: {\n    enabled?: boolean\n    label?: string\n    description?: string\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  name: string\n  due_date?: string\n  due_date_config?: {\n    duration: number\n    unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"\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  taxonomies?: string[]\n}\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### `TaskType`\n\n```ts\ntype TaskType = "MANUAL" | "AUTOMATION" | "DECISION" | "AI_AGENT"\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### `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      attributes?: { ... }\n      attributes_match?: { ... }\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}\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    attributes?: string[]\n    attributes_match?: "any" | "all"\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  attributes?: string[]\n  attributes_match?: "any" | "all"\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" | "years"\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" | "years"\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### `WorkflowDefinition`\n\nV1 workflow definition schema. Defines a linear workflow structure with sections\nand steps. Sections group related steps together, and steps represent individual\ntasks that need to be completed. This is the legacy workflow model; for new\nimplementations, consider using V2 flow templates instead.\n\n\n```ts\ntype WorkflowDefinition = {\n  id?: string\n  name: string\n  description?: string\n  creationTime?: string\n  enabled?: boolean\n  lastUpdateTime?: string\n  dueDate?: string\n  dynamicDueDate?: {\n    numberOfUnits: number\n    timePeriod: "minutes" | "hours" | "days" | "weeks" | "months" | "years"\n    actionTypeCondition: "WORKFLOW_STARTED" | "STEP_CLOSED" | "PHASE_FINISHED"\n    stepId?: string\n    phaseId?: string\n  }\n  userIds?: number[]\n  assignedTo?: string[]\n  enableECPWorkflow?: boolean\n  flow: Array<{\n    id?: string\n    name: string\n    order: number\n    type: "STEP" | "SECTION"\n    dueDate?: string\n    dynamicDueDate?: {\n      numberOfUnits: { ... }\n      timePeriod: { ... }\n      actionTypeCondition: { ... }\n      stepId?: { ... }\n      phaseId?: { ... }\n    }\n    assignedTo?: string[]\n    steps: Array<{\n      id?: { ... }\n      name: { ... }\n      description?: { ... }\n      executionType?: { ... }\n      automationConfig?: { ... }\n      journey?: { ... }\n      order: { ... }\n      dueDate?: { ... }\n      dynamicDueDate?: { ... }\n      userIds?: { ... }\n      requirements?: { ... }\n      assignedTo?: { ... }\n      type: { ... }\n      ecp?: { ... }\n      installer?: { ... }\n      partner?: { ... }\n      taxonomies?: { ... }\n    }>\n    taxonomies?: string[]\n  } | {\n    id?: string\n    name: string\n    description?: {\n      enabled?: { ... }\n      value?: { ... }\n    }\n    executionType?: "MANUAL" | "AUTOMATION"\n    automationConfig?: {\n      flowId: { ... }\n    }\n    journey?: {\n      id?: { ... }\n      journeyId?: { ... }\n      name?: { ... }\n      complete_task_automatically?: { ... }\n    }\n    order: number\n    dueDate?: string\n    dynamicDueDate?: {\n      numberOfUnits: { ... }\n      timePeriod: { ... }\n      actionTypeCondition: { ... }\n      stepId?: { ... }\n      phaseId?: { ... }\n    }\n    userIds?: number[]\n    requirements?: Array<{\n      definitionId: { ... }\n      type: { ... }\n      condition: { ... }\n    }>\n    assignedTo?: string[]\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    partner?: {\n      enabled?: { ... }\n  // ...\n}\n```\n\n### `Step`\n\nAction that needs to be done in a Workflow\n\n```ts\ntype Step = {\n  id?: string\n  name: string\n  description?: {\n    enabled?: boolean\n    value?: string\n  }\n  executionType?: "MANUAL" | "AUTOMATION"\n  automationConfig?: {\n    flowId: string\n  }\n  journey?: {\n    id?: string\n    journeyId?: string\n    name?: string\n    complete_task_automatically?: boolean\n  }\n  order: number\n  dueDate?: string\n  dynamicDueDate?: {\n    numberOfUnits: number\n    timePeriod: "minutes" | "hours" | "days" | "weeks" | "months" | "years"\n    actionTypeCondition: "WORKFLOW_STARTED" | "STEP_CLOSED" | "PHASE_FINISHED"\n    stepId?: string\n    phaseId?: string\n  }\n  userIds?: number[]\n  requirements?: Array<{\n    definitionId: string\n    type: "STEP" | "SECTION"\n    condition: "CLOSED"\n  }>\n  assignedTo?: string[]\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  partner?: {\n    enabled?: boolean\n    label?: string\n    description?: string\n  }\n  taxonomies?: 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  name: string\n  order: number\n  type: "STEP" | "SECTION"\n  dueDate?: string\n  dynamicDueDate?: {\n    numberOfUnits: number\n    timePeriod: "minutes" | "hours" | "days" | "weeks" | "months" | "years"\n    actionTypeCondition: "WORKFLOW_STARTED" | "STEP_CLOSED" | "PHASE_FINISHED"\n    stepId?: string\n    phaseId?: string\n  }\n  assignedTo?: string[]\n  steps: Array<{\n    id?: string\n    name: string\n    description?: {\n      enabled?: { ... }\n      value?: { ... }\n    }\n    executionType?: "MANUAL" | "AUTOMATION"\n    automationConfig?: {\n      flowId: { ... }\n    }\n    journey?: {\n      id?: { ... }\n      journeyId?: { ... }\n      name?: { ... }\n      complete_task_automatically?: { ... }\n    }\n    order: number\n    dueDate?: string\n    dynamicDueDate?: {\n      numberOfUnits: { ... }\n      timePeriod: { ... }\n      actionTypeCondition: { ... }\n      stepId?: { ... }\n      phaseId?: { ... }\n    }\n    userIds?: number[]\n    requirements?: Array<{\n      definitionId: { ... }\n      type: { ... }\n      condition: { ... }\n    }>\n    assignedTo?: string[]\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    partner?: {\n      enabled?: { ... }\n      label?: { ... }\n      description?: { ... }\n    }\n    taxonomies?: string[]\n  }>\n  taxonomies?: string[]\n}\n```\n\n### `TriggerType`\n\n```ts\ntype TriggerType = "MANUAL" | "AUTOMATIC"\n```\n\n### `ItemType`\n\n```ts\ntype ItemType = "STEP" | "SECTION"\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### `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### `PartnerDetails`\n\nDetails regarding partner for the workflow step\n\n```ts\ntype PartnerDetails = {\n  enabled?: boolean\n  label?: string\n  description?: string\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### `MaxAllowedLimit`\n\n```ts\ntype MaxAllowedLimit = {\n  currentNoOfWorkflows?: number\n  maxAllowed?: number\n}\n```\n\n### `DefinitionNotFoundResp`\n\nError response returned when a workflow definition or flow template is not found.\n\n```ts\ntype DefinitionNotFoundResp = {\n  message?: string\n}\n```\n\n### `ClosingReasonNotFoundResp`\n\nError response returned when a closing reason is not found.\n\n```ts\ntype ClosingReasonNotFoundResp = {\n  message?: string\n}\n```\n\n### `ChangeReasonStatusReq`\n\n```ts\ntype ChangeReasonStatusReq = {\n  status: "ACTIVE" | "INACTIVE"\n}\n```\n\n### `ClosingReasons`\n\n```ts\ntype ClosingReasons = {\n  reasons: Array<{\n    id?: string\n    title?: string\n    status?: "ACTIVE" | "INACTIVE"\n    lastUpdateTime?: string\n    creationTime?: string\n  }>\n}\n```\n\n### `ClosingReason`\n\nOne Closing reason for a workflow\n\n```ts\ntype ClosingReason = {\n  id?: string\n  title?: string\n  status?: "ACTIVE" | "INACTIVE"\n  lastUpdateTime?: string\n  creationTime?: string\n}\n```\n\n### `ClosingReasonsStatus`\n\n```ts\ntype ClosingReasonsStatus = "ACTIVE" | "INACTIVE"\n```\n\n### `ClosingReasonsIds`\n\n```ts\ntype ClosingReasonsIds = {\n  reasons: Array<{\n    id: string\n  }>\n}\n```\n\n### `ClosingReasonId`\n\n```ts\ntype ClosingReasonId = {\n  id: string\n}\n```\n\n### `ErrorResp`\n\nStandard error response returned when an API request fails.\n\n```ts\ntype ErrorResp = {\n  message?: 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\nConfiguration for calculating a due date dynamically based on workflow events.\nThe due date is computed by adding a duration (numberOfUnits + timePeriod) to\na reference point defined by actionTypeCondition (e.g., when workflow started,\nwhen a step closed, or when a phase finished).\n\n\n```ts\ntype DynamicDueDate = {\n  numberOfUnits: number\n  timePeriod: "minutes" | "hours" | "days" | "weeks" | "months" | "years"\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';
+
+
+exports.default = workflow_definition_default;

package/dist/{workflow-definition-runtime-2HQS3RPK.cjs → workflow-definition-runtime-DYKGFYQE.cjs}

@@ -1,5 +1,5 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
-var _chunkQNSMYDKGcjs = require('./chunk-QNSMYDKG.cjs');
+var _chunkADX7IYB3cjs = require('./chunk-ADX7IYB3.cjs');
 require('./chunk-NJK5F5TF.cjs');
-exports. default = _chunkQNSMYDKGcjs.require_workflow_definition_runtime.call(void 0, );
+exports. default = _chunkADX7IYB3cjs.require_workflow_definition_runtime.call(void 0, );

package/dist/{workflow-definition-runtime-JUPATIKU.js → workflow-definition-runtime-GYDTSAJL.js}

@@ -1,5 +1,5 @@
 import {
   require_workflow_definition_runtime
-} from "./chunk-OSPTVXY4.js";
+} from "./chunk-TTU24M3D.js";
 import "./chunk-YPSWSI3M.js";
 export default require_workflow_definition_runtime();

package/docs/access-token.md

@@ -48,6 +48,7 @@ const { data } = await accessTokenClient.createAccessToken(...)
 - [`TokenParameters`](#tokenparameters)
 - [`ExpiresIn`](#expiresin)
 - [`ReadOnly`](#readonly)
+- [`Anonymize`](#anonymize)
 - [`AccessTokenParameters`](#accesstokenparameters)
 - [`JourneyTokenParameters`](#journeytokenparameters)
 - [`PortalTokenParameters`](#portaltokenparameters)
@@ -72,7 +73,8 @@ const { data } = await client.createAccessToken(
     token_type: 'api',
     assignments: ['123:owner'],
     expires_in: 3600,
-    read_only: true
+    read_only: true,
+    anonymize: true
   },
 )
 ```
@@ -92,6 +94,7 @@ const { data } = await client.createAccessToken(
   "portal_user_id": "string",
   "assignments": ["123:owner"],
   "read_only": true,
+  "anonymize": true,
   "last_used": "2026-02-24"
 }
 ```
@@ -127,6 +130,7 @@ const { data } = await client.listAccessTokens({
     "portal_user_id": "string",
     "assignments": ["123:owner"],
     "read_only": true,
+    "anonymize": true,
     "last_used": "2026-02-24"
   }
 ]
@@ -162,6 +166,7 @@ const { data } = await client.revokeAccessToken({
   "portal_user_id": "string",
   "assignments": ["123:owner"],
   "read_only": true,
+  "anonymize": true,
   "last_used": "2026-02-24"
 }
 ```
@@ -403,6 +408,7 @@ type TokenParameters = {
   assignments?: string[]
   expires_in?: number | string
   read_only?: boolean
+  anonymize?: boolean
 } | {
   name: string
   token_type?: "journey"
@@ -418,12 +424,14 @@ type TokenParameters = {
   token_type?: "assume"
   assignments?: string[]
   read_only?: boolean
+  anonymize?: boolean
 } | {
   name: string
   token_type?: "app"
   assignments?: string[]
   expires_in?: number | string
   read_only?: boolean
+  anonymize?: boolean
 } | {
   name: string
   token_type?: "portal_preview"
@@ -446,6 +454,14 @@ When true, the issued token may only perform read-only actions. Any action guard
 type ReadOnly = boolean
 ```
 
+### `Anonymize`
+
+Forces PII anonymization on all entity data returned to this token. Cannot be disabled by the token bearer. See entity-api anonymized responses.
+
+```ts
+type Anonymize = boolean
+```
+
 ### `AccessTokenParameters`
 
 ```ts
@@ -455,6 +471,7 @@ type AccessTokenParameters = {
   assignments?: string[]
   expires_in?: number | string
   read_only?: boolean
+  anonymize?: boolean
 }
 ```
 
@@ -488,6 +505,7 @@ type AssumeTokenParameters = {
   token_type?: "assume"
   assignments?: string[]
   read_only?: boolean
+  anonymize?: boolean
 }
 ```
 
@@ -500,6 +518,7 @@ type AppTokenParameters = {
   assignments?: string[]
   expires_in?: number | string
   read_only?: boolean
+  anonymize?: boolean
 }
 ```
 
@@ -527,6 +546,7 @@ type AccessTokenItem = {
   portal_user_id?: string
   assignments?: string[]
   read_only?: boolean
+  anonymize?: boolean
   last_used?: string // date
 }
 ```

package/docs/customer-portal.md

@@ -124,6 +124,7 @@ const { data } = await customerPortalClient.upsertPortal(...)
 - [`updatePortalUserEmail`](#updateportaluseremail)
 - [`changePortalUserPassword`](#changeportaluserpassword)
 - [`postOrderAcceptance`](#postorderacceptance)
+- [`getContractWithTemplates`](#getcontractwithtemplates)
 - [`addContractByIdentifiers`](#addcontractbyidentifiers)
 - [`validateCadenceEntityEditRules`](#validatecadenceentityeditrules)
 - [`searchPaymentRelationsInEntities`](#searchpaymentrelationsinentities)
@@ -5185,6 +5186,144 @@ const { data } = await client.postOrderAcceptance(
 
 ---
 
+### `getContractWithTemplates`
+
+Get a contract by id, resolving the provided Handlebars templates against each related meter into templates_output. POST variant of getContract that accepts a request body; the GET remains as a fallba
+
+`POST /v2/portal/contract/{id}`
+
+```ts
+const { data } = await client.getContractWithTemplates(
+  {
+    id: '123e4567-e89b-12d3-a456-426614174000',
+  },
+  {
+    templates: {}
+  },
+)
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "entity": {
+    "_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
+    "_title": "Example Entity",
+    "_org": "123",
+    "_tags": ["example", "mock"],
+    "_created_at": "2021-02-09T12:41:43.662Z",
+    "_updated_at": "2021-02-09T12:41:43.662Z",
+    "templates_output_highlighted": {},
+    "search_snippets": [
+      {}
+    ],
+    "contract_name": "Grid Contract",
+    "contract_number": "12345",
+    "status": "approved",
+    "description": "This contract is for the supply of widgets.",
+    "account_number": "67890",
+    "branch": "power",
+    "billing_address": "123 Main St, Anytown",
+    "delivery_address": "456 Elm St, Anytown",
+    "additional_addresses": "789 Oak St, Anytown",
+    "termination_date": "2022-01-01",
+    "termination_reason": "Non-payment",
+    "billing_period": "monthly",
+    "billing_duration_amount": 30,
+    "renewal_duration_amount": 365,
+    "renewal_duration_unit": "years",
+    "notice_time_amount": 30,
+    "notice_time_unit": "months",
+    "start_date": "2021-01-01",
+    "billing_due_day": 2,
+    "installment_amount": 10050,
+    "balance": 8990,
+    "balance_currency": "EUR"
+  },
+  "orders": [
+    {
+      "_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
+      "_title": "Example Entity",
+      "_org": "123",
+      "_tags": ["example", "mock"],
+      "_created_at": "2021-02-09T12:41:43.662Z",
+      "_updated_at": "2021-02-09T12:41:43.662Z",
+      "templates_output_highlighted": {},
+      "search_snippets": [],
+      "_schema": "order"
+    }
+  ],
+  "meters": [
+    {
+      "_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
+      "_title": "Example Entity",
+      "_org": "123",
+      "_tags": ["example", "mock"],
+      "_created_at": "2021-02-09T12:41:43.662Z",
+      "_updated_at": "2021-02-09T12:41:43.662Z",
+      "templates_output_highlighted": {},
+      "search_snippets": [],
+      "_schema": "meter",
+      "templates_output": {}
+    }
+  ],
+  "files": [
+    {
+      "_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
+      "_title": "Example Entity",
+      "_org": "123",
+      "_tags": ["example", "mock"],
+      "_created_at": "2021-02-09T12:41:43.662Z",
+      "_updated_at": "2021-02-09T12:41:43.662Z",
+      "templates_output_highlighted": {},
+      "search_snippets": [],
+      "_schema": "file"
+    }
+  ],
+  "relations": [
+    {
+      "_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
+      "_title": "Example Entity",
+      "_org": "123",
+      "_tags": ["example", "mock"],
+      "_created_at": "2021-02-09T12:41:43.662Z",
+      "_updated_at": "2021-02-09T12:41:43.662Z",
+      "templates_output_highlighted": {},
+      "search_snippets": [],
+      "templates_output": {},
+      "_schema": "contact"
+    }
+  ],
+  "workflow": [
+    {
+      "id": "8gja72h6kas6h",
+      "name": "Lead Qualification",
+      "trigger": "MANUAL",
+      "status": "STARTED",
+      "creationTime": "2021-04-27T12:01:13.000Z",
+      "lastUpdateTime": "2021-04-27T12:01:13.000Z",
+      "dueDate": "2021-04-27T12:01:13.000Z",
+      "assignedTo": ["252", "29052"],
+      "flow": []
+    }
+  ],
+  "journey_actions": [
+    {
+      "journey_id": "string",
+      "action_label": {},
+      "slug": "string",
+      "rules": []
+    }
+  ]
+}
+```
+
+</details>
+
+---
+
 ### `addContractByIdentifiers`
 
 Self-assign contract(s) by pre-configured identifiers.