@epilot/sdk 2.9.3 → 2.9.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (126) hide show
  1. package/definitions/workflow-runtime.json +1 -1
  2. package/definitions/workflow.json +445 -60
  3. package/dist/apis/access-token.cjs +6 -6
  4. package/dist/apis/access-token.js +1 -1
  5. package/dist/apis/address-suggestions.cjs +6 -6
  6. package/dist/apis/address-suggestions.js +1 -1
  7. package/dist/apis/address.cjs +6 -6
  8. package/dist/apis/address.js +1 -1
  9. package/dist/apis/ai-agents.cjs +6 -6
  10. package/dist/apis/ai-agents.js +1 -1
  11. package/dist/apis/app.cjs +6 -6
  12. package/dist/apis/app.js +1 -1
  13. package/dist/apis/audit-logs.cjs +6 -6
  14. package/dist/apis/audit-logs.js +1 -1
  15. package/dist/apis/automation.cjs +6 -6
  16. package/dist/apis/automation.js +1 -1
  17. package/dist/apis/billing.cjs +6 -6
  18. package/dist/apis/billing.js +1 -1
  19. package/dist/apis/blueprint-manifest.cjs +6 -6
  20. package/dist/apis/blueprint-manifest.js +1 -1
  21. package/dist/apis/calendar.cjs +6 -6
  22. package/dist/apis/calendar.js +1 -1
  23. package/dist/apis/configuration-hub.cjs +6 -6
  24. package/dist/apis/configuration-hub.js +1 -1
  25. package/dist/apis/consent.cjs +6 -6
  26. package/dist/apis/consent.js +1 -1
  27. package/dist/apis/customer-portal.cjs +6 -6
  28. package/dist/apis/customer-portal.js +1 -1
  29. package/dist/apis/dashboard.cjs +6 -6
  30. package/dist/apis/dashboard.js +1 -1
  31. package/dist/apis/data-governance.cjs +6 -6
  32. package/dist/apis/data-governance.js +1 -1
  33. package/dist/apis/deduplication.cjs +6 -6
  34. package/dist/apis/deduplication.js +1 -1
  35. package/dist/apis/design.cjs +6 -6
  36. package/dist/apis/design.js +1 -1
  37. package/dist/apis/document.cjs +6 -6
  38. package/dist/apis/document.js +1 -1
  39. package/dist/apis/email-settings.cjs +6 -6
  40. package/dist/apis/email-settings.js +1 -1
  41. package/dist/apis/email-template.cjs +6 -6
  42. package/dist/apis/email-template.js +1 -1
  43. package/dist/apis/entity-mapping.cjs +6 -6
  44. package/dist/apis/entity-mapping.js +1 -1
  45. package/dist/apis/entity.cjs +6 -6
  46. package/dist/apis/entity.js +1 -1
  47. package/dist/apis/environments.cjs +6 -6
  48. package/dist/apis/environments.js +1 -1
  49. package/dist/apis/event-catalog.cjs +6 -6
  50. package/dist/apis/event-catalog.js +1 -1
  51. package/dist/apis/file.cjs +6 -6
  52. package/dist/apis/file.js +1 -1
  53. package/dist/apis/iban.cjs +6 -6
  54. package/dist/apis/iban.js +1 -1
  55. package/dist/apis/integration-toolkit.cjs +6 -6
  56. package/dist/apis/integration-toolkit.js +1 -1
  57. package/dist/apis/journey.cjs +6 -6
  58. package/dist/apis/journey.js +1 -1
  59. package/dist/apis/kanban.cjs +6 -6
  60. package/dist/apis/kanban.js +1 -1
  61. package/dist/apis/message.cjs +6 -6
  62. package/dist/apis/message.js +1 -1
  63. package/dist/apis/metering.cjs +6 -6
  64. package/dist/apis/metering.js +1 -1
  65. package/dist/apis/notes.cjs +6 -6
  66. package/dist/apis/notes.js +1 -1
  67. package/dist/apis/notification.cjs +6 -6
  68. package/dist/apis/notification.js +1 -1
  69. package/dist/apis/organization.cjs +6 -6
  70. package/dist/apis/organization.js +1 -1
  71. package/dist/apis/partner-directory.cjs +6 -6
  72. package/dist/apis/partner-directory.js +1 -1
  73. package/dist/apis/permissions.cjs +6 -6
  74. package/dist/apis/permissions.js +1 -1
  75. package/dist/apis/pricing-tier.cjs +6 -6
  76. package/dist/apis/pricing-tier.js +1 -1
  77. package/dist/apis/pricing.cjs +6 -6
  78. package/dist/apis/pricing.js +1 -1
  79. package/dist/apis/purpose.cjs +6 -6
  80. package/dist/apis/purpose.js +1 -1
  81. package/dist/apis/query.cjs +6 -6
  82. package/dist/apis/query.js +1 -1
  83. package/dist/apis/sandbox.cjs +6 -6
  84. package/dist/apis/sandbox.js +1 -1
  85. package/dist/apis/sharing.cjs +6 -6
  86. package/dist/apis/sharing.js +1 -1
  87. package/dist/apis/snapshot.cjs +6 -6
  88. package/dist/apis/snapshot.js +1 -1
  89. package/dist/apis/submission.cjs +6 -6
  90. package/dist/apis/submission.js +1 -1
  91. package/dist/apis/target.cjs +6 -6
  92. package/dist/apis/target.js +1 -1
  93. package/dist/apis/targeting.cjs +6 -6
  94. package/dist/apis/targeting.js +1 -1
  95. package/dist/apis/template-variables.cjs +6 -6
  96. package/dist/apis/template-variables.js +1 -1
  97. package/dist/apis/user.cjs +6 -6
  98. package/dist/apis/user.js +1 -1
  99. package/dist/apis/validation-rules.cjs +6 -6
  100. package/dist/apis/validation-rules.js +1 -1
  101. package/dist/apis/webhooks.cjs +6 -6
  102. package/dist/apis/webhooks.js +1 -1
  103. package/dist/apis/workflow-definition.cjs +6 -6
  104. package/dist/apis/workflow-definition.js +1 -1
  105. package/dist/apis/workflow.cjs +8 -8
  106. package/dist/apis/workflow.d.cts +2 -2
  107. package/dist/apis/workflow.d.ts +2 -2
  108. package/dist/apis/workflow.js +2 -2
  109. package/dist/{chunk-KQKBSWGI.js → chunk-522LYPPW.js} +1 -1
  110. package/dist/{chunk-MBVZHZAH.js → chunk-J4ZE3ANW.js} +2 -2
  111. package/dist/{chunk-DCHUVJL4.cjs → chunk-LNVAFYGS.cjs} +2 -2
  112. package/dist/{chunk-QNZPOA54.cjs → chunk-PM25LLET.cjs} +1 -1
  113. package/dist/index.cjs +10 -10
  114. package/dist/index.d.cts +1 -1
  115. package/dist/index.d.ts +1 -1
  116. package/dist/index.js +2 -2
  117. package/dist/workflow-7OU2YEEI.cjs +7 -0
  118. package/dist/workflow-IVKCWS44.js +7 -0
  119. package/dist/{workflow-runtime-DNTQDYPQ.js → workflow-runtime-L5HMFISV.js} +1 -1
  120. package/dist/{workflow-runtime-VKFESVFX.cjs → workflow-runtime-LMGACZP4.cjs} +2 -2
  121. package/dist/{workflow.d-CMSKt8oN.d.cts → workflow.d-eFv0ecBi.d.cts} +745 -81
  122. package/dist/{workflow.d-CMSKt8oN.d.ts → workflow.d-eFv0ecBi.d.ts} +745 -81
  123. package/docs/workflow.md +247 -47
  124. package/package.json +1 -1
  125. package/dist/workflow-3WBD74WR.js +0 -7
  126. package/dist/workflow-WIUZ5TOX.cjs +0 -7
package/docs/workflow.md CHANGED
@@ -51,6 +51,7 @@ const { data } = await workflowClient.getExecutions(...)
51
51
  - [`patchPhase`](#patchphase)
52
52
  - [`addTask`](#addtask)
53
53
  - [`cancelTaskSchedule`](#canceltaskschedule)
54
+ - [`reconcileAutomationTask`](#reconcileautomationtask)
54
55
  - [`runTaskScheduleNow`](#runtaskschedulenow)
55
56
 
56
57
  **Schemas**
@@ -210,7 +211,7 @@ const { data } = await client.getExecutions({
210
211
 
211
212
  ### `createExecution`
212
213
 
213
- Create a Workflow Execution. Start a new workflow execution, based on a workflow definition (template).
214
+ Creates a new V1 Workflow Execution from a workflow definition (template).
214
215
 
215
216
  `POST /v1/workflows/executions`
216
217
 
@@ -284,7 +285,7 @@ const { data } = await client.createExecution(
284
285
 
285
286
  ### `getExecution`
286
287
 
287
- Get a full workflow execution, included steps information, by execution id.
288
+ Retrieves a complete V1 workflow execution by ID, including all steps information.
288
289
 
289
290
  `GET /v1/workflows/executions/{executionId}`
290
291
 
@@ -522,7 +523,7 @@ const { data } = await client.createStep(
522
523
 
523
524
  ### `updateStep`
524
525
 
525
- Patches various changes to a workflow execution step.
526
+ Updates a workflow execution step with new values for status, assignees, due date, position, and more.
526
527
 
527
528
  `PATCH /v1/workflows/executions/{executionId}/steps/{stepId}`
528
529
 
@@ -707,7 +708,7 @@ const { data } = await client.getClosingReasonExecution({
707
708
 
708
709
  ### `startFlowExecution`
709
710
 
710
- Starts a new Flow Execution based on a flow template.
711
+ Starts a new Flow Execution based on a flow template (definition).
711
712
 
712
713
  `POST /v2/flows/executions`
713
714
 
@@ -715,7 +716,7 @@ Starts a new Flow Execution based on a flow template.
715
716
  const { data } = await client.startFlowExecution(
716
717
  null,
717
718
  {
718
- flow_template_id: 'string',
719
+ flow_template_id: 'tpl_abc123def456',
719
720
  trigger: {
720
721
  type: 'MANUAL',
721
722
  automation_config: {
@@ -726,7 +727,9 @@ const { data } = await client.startFlowExecution(
726
727
  input_context: {
727
728
  source: 'trigger',
728
729
  task_id: 'string'
729
- }
730
+ },
731
+ heal_attempts: 0,
732
+ last_heal_attempted_at: '1970-01-01T00:00:00.000Z'
730
733
  }
731
734
  },
732
735
  contexts: [
@@ -778,7 +781,8 @@ const { data } = await client.startFlowExecution(
778
781
  ],
779
782
  "crt_tasks": [
780
783
  {
781
- "id": "string"
784
+ "id": "string",
785
+ "crt_since": "1970-01-01T00:00:00.000Z"
782
786
  }
783
787
  ],
784
788
  "phases": [
@@ -861,7 +865,9 @@ const { data } = await client.startFlowExecution(
861
865
  "execution_id": "string",
862
866
  "execution_status": "string",
863
867
  "error_reason": "string",
864
- "input_context": {}
868
+ "input_context": {},
869
+ "heal_attempts": 0,
870
+ "last_heal_attempted_at": "1970-01-01T00:00:00.000Z"
865
871
  }
866
872
  },
867
873
  "singleClosingReasonSelection": true
@@ -874,7 +880,7 @@ const { data } = await client.startFlowExecution(
874
880
 
875
881
  ### `getFlowExecution`
876
882
 
877
- Get a full flow execution, included tasks, phases, edges & analytics.
883
+ Retrieves a complete flow execution by ID, including all phases, tasks, edges, contexts, and analytics.
878
884
 
879
885
  `GET /v2/flows/executions/{execution_id}`
880
886
 
@@ -921,7 +927,8 @@ const { data } = await client.getFlowExecution({
921
927
  ],
922
928
  "crt_tasks": [
923
929
  {
924
- "id": "string"
930
+ "id": "string",
931
+ "crt_since": "1970-01-01T00:00:00.000Z"
925
932
  }
926
933
  ],
927
934
  "phases": [
@@ -1004,7 +1011,9 @@ const { data } = await client.getFlowExecution({
1004
1011
  "execution_id": "string",
1005
1012
  "execution_status": "string",
1006
1013
  "error_reason": "string",
1007
- "input_context": {}
1014
+ "input_context": {},
1015
+ "heal_attempts": 0,
1016
+ "last_heal_attempted_at": "1970-01-01T00:00:00.000Z"
1008
1017
  }
1009
1018
  },
1010
1019
  "singleClosingReasonSelection": true
@@ -1100,7 +1109,8 @@ const { data } = await client.patchFlowExecution(
1100
1109
  ],
1101
1110
  "crt_tasks": [
1102
1111
  {
1103
- "id": "string"
1112
+ "id": "string",
1113
+ "crt_since": "1970-01-01T00:00:00.000Z"
1104
1114
  }
1105
1115
  ],
1106
1116
  "phases": [
@@ -1183,7 +1193,9 @@ const { data } = await client.patchFlowExecution(
1183
1193
  "execution_id": "string",
1184
1194
  "execution_status": "string",
1185
1195
  "error_reason": "string",
1186
- "input_context": {}
1196
+ "input_context": {},
1197
+ "heal_attempts": 0,
1198
+ "last_heal_attempted_at": "1970-01-01T00:00:00.000Z"
1187
1199
  }
1188
1200
  },
1189
1201
  "singleClosingReasonSelection": true
@@ -1266,7 +1278,7 @@ const { data } = await client.searchFlowExecutions(
1266
1278
 
1267
1279
  ### `patchTask`
1268
1280
 
1269
- Changes various attributes of a flow task, like assignees, status, due date, etc.
1281
+ Updates attributes of a flow task including status, assignees, due date, and more.
1270
1282
 
1271
1283
  `PATCH /v2/flows/executions/{execution_id}/tasks/{task_id}`
1272
1284
 
@@ -1277,9 +1289,9 @@ const { data } = await client.patchTask(
1277
1289
  task_id: 'example',
1278
1290
  },
1279
1291
  {
1280
- name: 'string',
1292
+ name: 'Review customer application',
1281
1293
  status: 'UNASSIGNED',
1282
- due_date: '2021-04-27T12:00:00.000Z',
1294
+ due_date: '2026-05-28T00:00:00.000',
1283
1295
  due_date_config: {
1284
1296
  duration: 0,
1285
1297
  unit: 'minutes',
@@ -1297,7 +1309,9 @@ const { data } = await client.patchTask(
1297
1309
  input_context: {
1298
1310
  source: 'trigger',
1299
1311
  task_id: 'string'
1300
- }
1312
+ },
1313
+ heal_attempts: 0,
1314
+ last_heal_attempted_at: '1970-01-01T00:00:00.000Z'
1301
1315
  },
1302
1316
  description: {
1303
1317
  enabled: true,
@@ -1330,8 +1344,9 @@ const { data } = await client.patchTask(
1330
1344
  label: 'string',
1331
1345
  description: 'string'
1332
1346
  },
1333
- next_condition_id: 'string',
1334
- revert_execution: false
1347
+ next_condition_id: 'cond_branch_approved',
1348
+ revert_execution: false,
1349
+ completed_via_journey: false
1335
1350
  },
1336
1351
  )
1337
1352
  ```
@@ -1526,7 +1541,9 @@ const { data } = await client.runTaskAutomation({
1526
1541
  "input_context": {
1527
1542
  "source": "trigger",
1528
1543
  "task_id": "string"
1529
- }
1544
+ },
1545
+ "heal_attempts": 0,
1546
+ "last_heal_attempted_at": "1970-01-01T00:00:00.000Z"
1530
1547
  },
1531
1548
  "automation_execution_id": "string",
1532
1549
  "trigger_mode": "manual",
@@ -1751,7 +1768,9 @@ const { data } = await client.addTask(
1751
1768
  input_context: {
1752
1769
  source: 'trigger',
1753
1770
  task_id: 'string'
1754
- }
1771
+ },
1772
+ heal_attempts: 0,
1773
+ last_heal_attempted_at: '1970-01-01T00:00:00.000Z'
1755
1774
  },
1756
1775
  phase_id: 'string',
1757
1776
  task_type: 'MANUAL'
@@ -1865,6 +1884,153 @@ const { data } = await client.cancelTaskSchedule({
1865
1884
 
1866
1885
  ---
1867
1886
 
1887
+ ### `reconcileAutomationTask`
1888
+
1889
+ Reconciles an automation task's status against its linked automation execution.
1890
+
1891
+ `POST /v2/flows/executions/{execution_id}/tasks/{task_id}/reconcile-automation`
1892
+
1893
+ ```ts
1894
+ const { data } = await client.reconcileAutomationTask({
1895
+ execution_id: 'example',
1896
+ task_id: 'example',
1897
+ })
1898
+ ```
1899
+
1900
+ <details>
1901
+ <summary>Response</summary>
1902
+
1903
+ ```json
1904
+ {
1905
+ "id": "string",
1906
+ "flow_template_id": "string",
1907
+ "org_id": "string",
1908
+ "name": "string",
1909
+ "created_at": "string",
1910
+ "updated_at": "string",
1911
+ "due_date": "string",
1912
+ "due_date_config": {
1913
+ "duration": 0,
1914
+ "unit": "minutes",
1915
+ "type": "WORKFLOW_STARTED",
1916
+ "task_id": "string",
1917
+ "phase_id": "string"
1918
+ },
1919
+ "status": "STARTED",
1920
+ "assigned_to": ["string"],
1921
+ "analytics": {
1922
+ "started_at": "string",
1923
+ "completed_at": "string",
1924
+ "closed_at": "string",
1925
+ "started_by": "string",
1926
+ "closed_by": "string"
1927
+ },
1928
+ "contexts": [
1929
+ {
1930
+ "entity_id": "string",
1931
+ "entity_schema": "string",
1932
+ "is_primary": false
1933
+ }
1934
+ ],
1935
+ "crt_tasks": [
1936
+ {
1937
+ "id": "string",
1938
+ "crt_since": "1970-01-01T00:00:00.000Z"
1939
+ }
1940
+ ],
1941
+ "phases": [
1942
+ {
1943
+ "id": "string",
1944
+ "template_id": "string",
1945
+ "name": "string",
1946
+ "status": "OPEN",
1947
+ "updated_at": "string",
1948
+ "due_date": "2021-04-27T12:00:00.000Z",
1949
+ "due_date_config": {},
1950
+ "assigned_to": ["string"],
1951
+ "analytics": {},
1952
+ "taxonomies": ["string"],
1953
+ "loop_config": {}
1954
+ }
1955
+ ],
1956
+ "tasks": [
1957
+ {
1958
+ "id": "string",
1959
+ "template_id": "string",
1960
+ "name": "string",
1961
+ "description": {},
1962
+ "status": "UNASSIGNED",
1963
+ "journey": {},
1964
+ "due_date": "2021-04-27T12:00:00.000Z",
1965
+ "due_date_config": {},
1966
+ "requirements": [],
1967
+ "assigned_to": ["string"],
1968
+ "analytics": {},
1969
+ "created_at": "1970-01-01T00:00:00.000Z",
1970
+ "updated_at": "1970-01-01T00:00:00.000Z",
1971
+ "manually_created": true,
1972
+ "enabled": true,
1973
+ "ecp": {},
1974
+ "installer": {},
1975
+ "partner": {},
1976
+ "taxonomies": ["string"],
1977
+ "phase_id": "string",
1978
+ "task_type": "MANUAL",
1979
+ "loop_config": {}
1980
+ }
1981
+ ],
1982
+ "edges": [
1983
+ {
1984
+ "id": "string",
1985
+ "from_id": "string",
1986
+ "to_id": "string",
1987
+ "condition_id": "abc123",
1988
+ "none_met": true
1989
+ }
1990
+ ],
1991
+ "_execution_chain": {
1992
+ "parent_execution_id": "string",
1993
+ "parent_task_id": "string",
1994
+ "depth": 0
1995
+ },
1996
+ "closing_reason": {
1997
+ "selected_reasons": [
1998
+ {}
1999
+ ],
2000
+ "configured_reasons": [
2001
+ {}
2002
+ ],
2003
+ "extra_description": "string"
2004
+ },
2005
+ "available_in_ecp": true,
2006
+ "entity_sync": [
2007
+ {
2008
+ "trigger": {},
2009
+ "target": {},
2010
+ "value": {}
2011
+ }
2012
+ ],
2013
+ "taxonomies": ["string"],
2014
+ "trigger": {
2015
+ "type": "MANUAL",
2016
+ "automation_config": {
2017
+ "flow_id": "string",
2018
+ "execution_id": "string",
2019
+ "execution_status": "string",
2020
+ "error_reason": "string",
2021
+ "input_context": {},
2022
+ "heal_attempts": 0,
2023
+ "last_heal_attempted_at": "1970-01-01T00:00:00.000Z"
2024
+ }
2025
+ },
2026
+ "singleClosingReasonSelection": true
2027
+ }
2028
+ ```
2029
+
2030
+ </details>
2031
+
2032
+ ---
2033
+
1868
2034
  ### `runTaskScheduleNow`
1869
2035
 
1870
2036
  Cancels the pending schedule for a task and immediately triggers its automation execution.
@@ -3264,9 +3430,13 @@ type ExecutionPaginationDynamo = {
3264
3430
 
3265
3431
  ### `ErrorResp`
3266
3432
 
3433
+ Standard error response returned when an API request fails.
3434
+ Contains a human-readable message describing the error.
3435
+
3436
+
3267
3437
  ```ts
3268
3438
  type ErrorResp = {
3269
- message?: string
3439
+ message: string
3270
3440
  }
3271
3441
  ```
3272
3442
 
@@ -3391,6 +3561,9 @@ type StepRequirement = {
3391
3561
 
3392
3562
  ### `StartFlowReq`
3393
3563
 
3564
+ Request payload for starting a new flow execution from a template.
3565
+
3566
+
3394
3567
  ```ts
3395
3568
  type StartFlowReq = {
3396
3569
  flow_template_id: string
@@ -3402,6 +3575,8 @@ type StartFlowReq = {
3402
3575
  execution_status?: { ... }
3403
3576
  error_reason?: { ... }
3404
3577
  input_context?: { ... }
3578
+ heal_attempts?: { ... }
3579
+ last_heal_attempted_at?: { ... }
3405
3580
  }
3406
3581
  }
3407
3582
  contexts: Array<{
@@ -3445,7 +3620,7 @@ type PatchFlowReq = {
3445
3620
  due_date?: string
3446
3621
  due_date_config?: {
3447
3622
  duration: number
3448
- unit: "minutes" | "hours" | "days" | "weeks" | "months"
3623
+ unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
3449
3624
  type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"
3450
3625
  task_id?: string
3451
3626
  phase_id?: string
@@ -3471,7 +3646,7 @@ type FlowExecution = {
3471
3646
  due_date?: string
3472
3647
  due_date_config?: {
3473
3648
  duration: number
3474
- unit: "minutes" | "hours" | "days" | "weeks" | "months"
3649
+ unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
3475
3650
  type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"
3476
3651
  task_id?: string
3477
3652
  phase_id?: string
@@ -3495,6 +3670,7 @@ type FlowExecution = {
3495
3670
  }>
3496
3671
  crt_tasks: Array<{
3497
3672
  id?: string
3673
+ crt_since?: string // date-time
3498
3674
  }>
3499
3675
  phases?: Array<{
3500
3676
  id: string
@@ -3560,7 +3736,6 @@ type FlowExecution = {
3560
3736
  }>
3561
3737
  assigned_to?: Array<string | {
3562
3738
  variable: { ... }
3563
- value?: { ... }
3564
3739
  // ...
3565
3740
  }
3566
3741
  ```
@@ -3595,6 +3770,8 @@ type FlowTrigger = {
3595
3770
  source: { ... }
3596
3771
  task_id?: { ... }
3597
3772
  }
3773
+ heal_attempts?: number
3774
+ last_heal_attempted_at?: string // date-time
3598
3775
  }
3599
3776
  }
3600
3777
  ```
@@ -3652,7 +3829,7 @@ type Task = {
3652
3829
  due_date?: string
3653
3830
  due_date_config?: {
3654
3831
  duration: number
3655
- unit: "minutes" | "hours" | "days" | "weeks" | "months"
3832
+ unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
3656
3833
  type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"
3657
3834
  task_id?: string
3658
3835
  phase_id?: string
@@ -3732,7 +3909,7 @@ type Task = {
3732
3909
  due_date?: string
3733
3910
  due_date_config?: {
3734
3911
  duration: number
3735
- unit: "minutes" | "hours" | "days" | "weeks" | "months"
3912
+ unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
3736
3913
  type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"
3737
3914
  // ...
3738
3915
  }
@@ -3765,7 +3942,7 @@ type ManualTask = {
3765
3942
  due_date?: string
3766
3943
  due_date_config?: {
3767
3944
  duration: number
3768
- unit: "minutes" | "hours" | "days" | "weeks" | "months"
3945
+ unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
3769
3946
  type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"
3770
3947
  task_id?: string
3771
3948
  phase_id?: string
@@ -3851,7 +4028,7 @@ type AutomationTask = {
3851
4028
  due_date?: string
3852
4029
  due_date_config?: {
3853
4030
  duration: number
3854
- unit: "minutes" | "hours" | "days" | "weeks" | "months"
4031
+ unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
3855
4032
  type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"
3856
4033
  task_id?: string
3857
4034
  phase_id?: string
@@ -3918,6 +4095,8 @@ type AutomationTask = {
3918
4095
  source: { ... }
3919
4096
  task_id?: { ... }
3920
4097
  }
4098
+ heal_attempts?: number
4099
+ last_heal_attempted_at?: string // date-time
3921
4100
  }
3922
4101
  automation_execution_id?: string
3923
4102
  trigger_mode?: "manual" | "automatic"
@@ -3926,13 +4105,11 @@ type AutomationTask = {
3926
4105
  } | {
3927
4106
  mode: "delayed"
3928
4107
  duration: number
3929
- unit: "minutes" | "hours" | "days" | "weeks" | "months"
4108
+ unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
3930
4109
  schedule_id?: string
4110
+ scheduled_at?: string
3931
4111
  } | {
3932
4112
  mode: "relative"
3933
- direction: "before" | "after"
3934
- duration: number
3935
- unit: "minutes" | "hours" | "days" | "weeks" | "months"
3936
4113
  // ...
3937
4114
  }
3938
4115
  ```
@@ -3973,13 +4150,14 @@ type ActionSchedule = {
3973
4150
  } | {
3974
4151
  mode: "delayed"
3975
4152
  duration: number
3976
- unit: "minutes" | "hours" | "days" | "weeks" | "months"
4153
+ unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
3977
4154
  schedule_id?: string
4155
+ scheduled_at?: string
3978
4156
  } | {
3979
4157
  mode: "relative"
3980
4158
  direction: "before" | "after"
3981
4159
  duration: number
3982
- unit: "minutes" | "hours" | "days" | "weeks" | "months"
4160
+ unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
3983
4161
  reference: {
3984
4162
  id: string
3985
4163
  origin: "flow_started" | "task_completed" | "trigger_entity_attribute" | "all_preceding_tasks_completed"
@@ -3987,6 +4165,7 @@ type ActionSchedule = {
3987
4165
  attribute?: string
3988
4166
  }
3989
4167
  schedule_id?: string
4168
+ scheduled_at?: string
3990
4169
  }
3991
4170
  ```
3992
4171
 
@@ -4004,8 +4183,9 @@ type ImmediateSchedule = {
4004
4183
  type DelayedSchedule = {
4005
4184
  mode: "delayed"
4006
4185
  duration: number
4007
- unit: "minutes" | "hours" | "days" | "weeks" | "months"
4186
+ unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
4008
4187
  schedule_id?: string
4188
+ scheduled_at?: string
4009
4189
  }
4010
4190
  ```
4011
4191
 
@@ -4016,7 +4196,7 @@ type RelativeSchedule = {
4016
4196
  mode: "relative"
4017
4197
  direction: "before" | "after"
4018
4198
  duration: number
4019
- unit: "minutes" | "hours" | "days" | "weeks" | "months"
4199
+ unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
4020
4200
  reference: {
4021
4201
  id: string
4022
4202
  origin: "flow_started" | "task_completed" | "trigger_entity_attribute" | "all_preceding_tasks_completed"
@@ -4024,6 +4204,7 @@ type RelativeSchedule = {
4024
4204
  attribute?: string
4025
4205
  }
4026
4206
  schedule_id?: string
4207
+ scheduled_at?: string
4027
4208
  }
4028
4209
  ```
4029
4210
 
@@ -4048,7 +4229,7 @@ type DecisionTask = {
4048
4229
  due_date?: string
4049
4230
  due_date_config?: {
4050
4231
  duration: number
4051
- unit: "minutes" | "hours" | "days" | "weeks" | "months"
4232
+ unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
4052
4233
  type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"
4053
4234
  task_id?: string
4054
4235
  phase_id?: string
@@ -4125,11 +4306,11 @@ type DecisionTask = {
4125
4306
  schedule?: {
4126
4307
  mode: "delayed"
4127
4308
  duration: number
4128
- unit: "minutes" | "hours" | "days" | "weeks" | "months"
4309
+ unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
4129
4310
  schedule_id?: string
4311
+ scheduled_at?: string
4130
4312
  } | {
4131
4313
  mode: "relative"
4132
- direction: "before" | "after"
4133
4314
  // ...
4134
4315
  }
4135
4316
  ```
@@ -4155,7 +4336,7 @@ type AiAgentTask = {
4155
4336
  due_date?: string
4156
4337
  due_date_config?: {
4157
4338
  duration: number
4158
- unit: "minutes" | "hours" | "days" | "weeks" | "months"
4339
+ unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
4159
4340
  type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"
4160
4341
  task_id?: string
4161
4342
  phase_id?: string
@@ -4225,6 +4406,7 @@ type AiAgentTask = {
4225
4406
  execution_id?: string
4226
4407
  execution_status?: string
4227
4408
  error_reason?: string
4409
+ outcome?: string
4228
4410
  }
4229
4411
  agent_execution_id?: string
4230
4412
  }
@@ -4248,6 +4430,7 @@ type AgentExecutionInfo = {
4248
4430
  execution_id?: string
4249
4431
  execution_status?: string
4250
4432
  error_reason?: string
4433
+ outcome?: string
4251
4434
  }
4252
4435
  ```
4253
4436
 
@@ -4272,7 +4455,7 @@ type TaskBase = {
4272
4455
  due_date?: string
4273
4456
  due_date_config?: {
4274
4457
  duration: number
4275
- unit: "minutes" | "hours" | "days" | "weeks" | "months"
4458
+ unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
4276
4459
  type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"
4277
4460
  task_id?: string
4278
4461
  phase_id?: string
@@ -4345,7 +4528,7 @@ type Phase = {
4345
4528
  due_date?: string
4346
4529
  due_date_config?: {
4347
4530
  duration: number
4348
- unit: "minutes" | "hours" | "days" | "weeks" | "months"
4531
+ unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
4349
4532
  type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"
4350
4533
  task_id?: string
4351
4534
  phase_id?: string
@@ -4396,6 +4579,8 @@ type AutomationInfo = {
4396
4579
  source: "trigger" | "task"
4397
4580
  task_id?: string
4398
4581
  }
4582
+ heal_attempts?: number
4583
+ last_heal_attempted_at?: string // date-time
4399
4584
  }
4400
4585
  ```
4401
4586
 
@@ -4452,6 +4637,8 @@ type Condition = {
4452
4637
  attribute_type?: { ... }
4453
4638
  attribute_repeatable?: { ... }
4454
4639
  attribute_operation?: { ... }
4640
+ attributes?: { ... }
4641
+ attributes_match?: { ... }
4455
4642
  attribute_sub_field?: { ... }
4456
4643
  date_offset?: { ... }
4457
4644
  }
@@ -4478,6 +4665,8 @@ type Statement = {
4478
4665
  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"
4479
4666
  attribute_repeatable?: boolean
4480
4667
  attribute_operation?: "all" | "updated" | "added" | "deleted"
4668
+ attributes?: string[]
4669
+ attributes_match?: "any" | "all"
4481
4670
  attribute_sub_field?: string
4482
4671
  date_offset?: {
4483
4672
  amount?: { ... }
@@ -4502,6 +4691,8 @@ type EvaluationSource = {
4502
4691
  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"
4503
4692
  attribute_repeatable?: boolean
4504
4693
  attribute_operation?: "all" | "updated" | "added" | "deleted"
4694
+ attributes?: string[]
4695
+ attributes_match?: "any" | "all"
4505
4696
  attribute_sub_field?: string
4506
4697
  date_offset?: {
4507
4698
  amount?: number
@@ -4523,7 +4714,7 @@ Set due date for the task based on a dynamic condition
4523
4714
  ```ts
4524
4715
  type DueDateConfig = {
4525
4716
  duration: number
4526
- unit: "minutes" | "hours" | "days" | "weeks" | "months"
4717
+ unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
4527
4718
  type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"
4528
4719
  task_id?: string
4529
4720
  phase_id?: string
@@ -4533,7 +4724,7 @@ type DueDateConfig = {
4533
4724
  ### `TimeUnit`
4534
4725
 
4535
4726
  ```ts
4536
- type TimeUnit = "minutes" | "hours" | "days" | "weeks" | "months"
4727
+ type TimeUnit = "minutes" | "hours" | "days" | "weeks" | "months" | "years"
4537
4728
  ```
4538
4729
 
4539
4730
  ### `EnableRequirement`
@@ -4592,6 +4783,10 @@ type Assignees = Array<string | {
4592
4783
 
4593
4784
  ### `PatchTaskReq`
4594
4785
 
4786
+ Request payload for updating a task within a flow execution.
4787
+ All fields are optional; only provided fields will be updated.
4788
+
4789
+
4595
4790
  ```ts
4596
4791
  type PatchTaskReq = {
4597
4792
  name?: string
@@ -4599,7 +4794,7 @@ type PatchTaskReq = {
4599
4794
  due_date?: string
4600
4795
  due_date_config?: {
4601
4796
  duration: number
4602
- unit: "minutes" | "hours" | "days" | "weeks" | "months"
4797
+ unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
4603
4798
  type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"
4604
4799
  task_id?: string
4605
4800
  phase_id?: string
@@ -4618,6 +4813,8 @@ type PatchTaskReq = {
4618
4813
  source: { ... }
4619
4814
  task_id?: { ... }
4620
4815
  }
4816
+ heal_attempts?: number
4817
+ last_heal_attempted_at?: string // date-time
4621
4818
  }
4622
4819
  description?: {
4623
4820
  enabled?: boolean
@@ -4652,6 +4849,7 @@ type PatchTaskReq = {
4652
4849
  }
4653
4850
  next_condition_id?: string
4654
4851
  revert_execution?: boolean
4852
+ completed_via_journey?: boolean
4655
4853
  }
4656
4854
  ```
4657
4855
 
@@ -4663,7 +4861,7 @@ type PatchPhaseReq = {
4663
4861
  due_date?: string
4664
4862
  due_date_config?: {
4665
4863
  duration: number
4666
- unit: "minutes" | "hours" | "days" | "weeks" | "months"
4864
+ unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
4667
4865
  type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"
4668
4866
  task_id?: string
4669
4867
  phase_id?: string
@@ -4704,6 +4902,8 @@ type AddTaskReq = {
4704
4902
  execution_status?: { ... }
4705
4903
  error_reason?: { ... }
4706
4904
  input_context?: { ... }
4905
+ heal_attempts?: { ... }
4906
+ last_heal_attempted_at?: { ... }
4707
4907
  }
4708
4908
  phase_id?: string
4709
4909
  task_type?: "MANUAL" | "AUTOMATION" | "DECISION" | "AI_AGENT"