@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
@@ -95,6 +95,10 @@ declare namespace Components {
95
95
  */
96
96
  execution_status?: string;
97
97
  error_reason?: string;
98
+ /**
99
+ * Server-computed outcome read from the agent execution's structured_output (e.g. assigned, recommended, no_eligible_partner, missing_input). When the outcome means the work is not really done (no_eligible_partner, missing_input) the task is held as the current task instead of auto-completing, so the phase does not advance.
100
+ */
101
+ outcome?: string;
98
102
  }
99
103
  export interface AiAgentTask {
100
104
  id: TaskId;
@@ -228,6 +232,14 @@ declare namespace Components {
228
232
  *
229
233
  */
230
234
  AutomationInputContext;
235
+ /**
236
+ * Internal — number of times flow-healing-service has attempted to re-trigger this task's lost automation dispatch. Used to cap retries and avoid an indefinite heal-on-every-read storm against a deterministically-failing automation flow.
237
+ */
238
+ heal_attempts?: number;
239
+ /**
240
+ * Internal — timestamp of the most recent heal attempt for this task. flow-healing-service uses this as a per-task debounce gate so the heal cannot fire more than once per HEAL_RETRY_COOLDOWN_MS regardless of how often the flow execution is read.
241
+ */
242
+ last_heal_attempted_at?: string; // date-time
231
243
  }
232
244
  /**
233
245
  * Optional. Source of the entity fed into this automation task. If omitted, the workflow's primary entity is used.
@@ -461,6 +473,26 @@ declare namespace Components {
461
473
  * The id of the created schedule
462
474
  */
463
475
  schedule_id?: string;
476
+ /**
477
+ * The resolved absolute timestamp (ISO 8601, UTC) at which the task is
478
+ * armed to run. Set by the backend when the schedule is armed and the
479
+ * task transitions to SCHEDULED. Absent while the task is still
480
+ * pending/unscheduled.
481
+ *
482
+ * Note: intentionally typed as plain `string` (not
483
+ * `format: date-time`). `schedule` is embedded in the AutomationTask /
484
+ * DecisionTask schemas; if a future request body ever accepts a task
485
+ * (or schedule) and `safeParse`s it, `format: date-time` would make
486
+ * openapi-zod-client emit `z.string().datetime({ offset: true })` and
487
+ * reject any round-tripped value that is empty or tz-less — the exact
488
+ * mechanism behind the May 2026 due_date incident (513ed597 added the
489
+ * format, ee574b43 activated it via an unrelated regen; see commit
490
+ * 2c91ff35). This field is server-written via `toISOString()` so it is
491
+ * always a valid UTC instant; the datetime validator adds no
492
+ * protection, only latent risk.
493
+ *
494
+ */
495
+ scheduled_at?: string;
464
496
  }
465
497
  /**
466
498
  * Set due date for the task based on a dynamic condition
@@ -591,8 +623,18 @@ declare namespace Components {
591
623
  entityAttribute: string;
592
624
  };
593
625
  }
626
+ /**
627
+ * Standard error response returned when an API request fails.
628
+ * Contains a human-readable message describing the error.
629
+ *
630
+ */
594
631
  export interface ErrorResp {
595
- message?: string;
632
+ /**
633
+ * Human-readable description of the error that occurred
634
+ * example:
635
+ * Validation failed: workflowId is required
636
+ */
637
+ message: string;
596
638
  }
597
639
  export interface EvaluationSource {
598
640
  /**
@@ -606,6 +648,34 @@ declare namespace Components {
606
648
  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";
607
649
  attribute_repeatable?: boolean;
608
650
  attribute_operation?: "all" | "updated" | "added" | "deleted";
651
+ /**
652
+ * Multi-attribute mode. When present and length > 1, the statement is
653
+ * evaluated against every listed attribute and combined via
654
+ * `attributes_match`. All listed attributes must share the same
655
+ * `attribute_type`. Mutually exclusive with `attribute_sub_field`,
656
+ * `date_offset`, and `attribute_operation`. When absent or length === 1,
657
+ * the legacy `attribute` field is used.
658
+ *
659
+ */
660
+ attributes?: [
661
+ string?,
662
+ string?,
663
+ string?,
664
+ string?,
665
+ string?,
666
+ string?,
667
+ string?,
668
+ string?,
669
+ string?,
670
+ string?
671
+ ];
672
+ /**
673
+ * Inner connector across `attributes`. `any` (default) means at least
674
+ * one attribute must satisfy the operator; `all` means every attribute
675
+ * must satisfy it. Ignored when `attributes` is absent or has length < 2.
676
+ *
677
+ */
678
+ attributes_match?: "any" | "all";
609
679
  /**
610
680
  * For complex attribute types, specifies which sub-field to extract (e.g., 'address', 'name', 'email_type')
611
681
  */
@@ -682,6 +752,10 @@ declare namespace Components {
682
752
  contexts: FlowContext[];
683
753
  crt_tasks: {
684
754
  id?: TaskId;
755
+ /**
756
+ * Timestamp when this task entered crt_tasks (i.e. became current). Used by the flow-healing-service as the authoritative gate for "has this PENDING task been stuck long enough to heal?". Using the task's own analytics.status_updated_at as the gate produced false positives because transitioning a task INTO crt_tasks does not change its status — so that timestamp can be hours old for a freshly-current task.
757
+ */
758
+ crt_since?: string; // date-time
685
759
  }[];
686
760
  phases?: Phase[];
687
761
  tasks: Task[];
@@ -870,7 +944,17 @@ declare namespace Components {
870
944
  due_date_config?: /* Set due date for the task based on a dynamic condition */ DueDateConfig;
871
945
  assigned_to?: /* The user ids or variable assignments */ Assignees;
872
946
  }
947
+ /**
948
+ * Request payload for updating a task within a flow execution.
949
+ * All fields are optional; only provided fields will be updated.
950
+ *
951
+ */
873
952
  export interface PatchTaskReq {
953
+ /**
954
+ * Display name of the task
955
+ * example:
956
+ * Review customer application
957
+ */
874
958
  name?: string;
875
959
  status?: /**
876
960
  * **Note**: "UNASSIGNED" and "ASSIGNED" are deprecated and will be removed in a future version. Please use "PENDING" instead. Status values for workflow execution steps/tasks:
@@ -889,14 +973,37 @@ declare namespace Components {
889
973
  */
890
974
  StepStatus;
891
975
  /**
976
+ * Explicit due date for the task. Takes precedence over
977
+ * due_date_config if both are provided.
978
+ *
979
+ * Note: intentionally typed as plain `string` (not
980
+ * `format: date-time`). For day/week/month-precision due
981
+ * dates the server stores a "floating" datetime without a
982
+ * timezone designator (e.g. `2026-05-28T00:00:00.000`) so
983
+ * that the UI can render it as a date in the user's local
984
+ * timezone without shifting the displayed day. Tightening
985
+ * this to `format: date-time` causes openapi-zod-client to
986
+ * emit `z.string().datetime({ offset: true })` in
987
+ * `validators-generated.ts`, which then trips
988
+ * `safeParse(body)` in `patch-task.ts` whenever the
989
+ * sidebar sends a stored task back with a tz-less
990
+ * `due_date`. See commit 4aca299c (Aug 2024) for the
991
+ * original date-only display rationale and the May 2026
992
+ * incident (513ed597 added the format, ee574b43
993
+ * unintentionally activated it via an unrelated regen) for
994
+ * the history. Long-term, day-precision due dates should
995
+ * migrate to a separate `format: date` field.
996
+ *
892
997
  * example:
893
- * 2021-04-27T12:00:00.000Z
998
+ * 2026-05-28T00:00:00.000
894
999
  */
895
1000
  due_date?: string;
896
1001
  due_date_config?: /* Set due date for the task based on a dynamic condition */ DueDateConfig;
897
1002
  assigned_to?: /* The user ids or variable assignments */ Assignees;
898
1003
  /**
899
- * flag for controlling enabled/disabled state of the task
1004
+ * Controls whether the task is enabled (can be worked on) or disabled (grayed out).
1005
+ * Disabled tasks cannot have their status changed until re-enabled.
1006
+ *
900
1007
  */
901
1008
  enabled?: boolean;
902
1009
  automation_config?: AutomationInfo;
@@ -908,17 +1015,37 @@ declare namespace Components {
908
1015
  */
909
1016
  partner?: /* Details regarding partner for the workflow step */ PartnerDetails;
910
1017
  /**
911
- * Condition to evaluate as true for a decision task with a manual trigger mode
1018
+ * For decision tasks with manual trigger mode, specifies which condition/branch
1019
+ * to follow when completing the task. The condition ID must match one of the
1020
+ * conditions defined on the decision task.
1021
+ *
1022
+ * example:
1023
+ * cond_branch_approved
912
1024
  */
913
1025
  next_condition_id?: string;
914
1026
  /**
915
- * When patching an already completed/skipped task that comes before the current task, this flag controls whether to revert the execution:
916
- * - `true`: The patched task becomes the current task AND all succeeding tasks are reset to PENDING (full revert)
917
- * - `false` or omitted (undefined): The task is updated but the current task does not change and no downstream tasks are affected
918
- * This parameter is silently ignored when patching the current task or future tasks.
1027
+ * Controls behavior when updating a task that was already completed/skipped and
1028
+ * comes before the current task in the workflow:
1029
+ * - `true`: Reverts the execution - the patched task becomes the current task
1030
+ * and all subsequent tasks are reset to PENDING status
1031
+ * - `false` (default): Updates only this task without affecting workflow position
1032
+ * or other tasks
1033
+ *
1034
+ * **Important:** This parameter is silently ignored when:
1035
+ * - Patching the current task
1036
+ * - Patching future tasks (tasks that haven't been reached yet)
919
1037
  *
920
1038
  */
921
1039
  revert_execution?: boolean;
1040
+ /**
1041
+ * Request-only signal indicating the task is being completed as a
1042
+ * result of the user submitting the task's linked journey (journey
1043
+ * auto-completion). When `true` and the task transitions to
1044
+ * `COMPLETED`, the activity log records a journey-specific message
1045
+ * instead of the generic completion message. Not persisted on the task.
1046
+ *
1047
+ */
1048
+ completed_via_journey?: boolean;
922
1049
  }
923
1050
  export interface Phase {
924
1051
  id: PhaseId;
@@ -974,6 +1101,26 @@ declare namespace Components {
974
1101
  * The id of the created schedule
975
1102
  */
976
1103
  schedule_id?: string;
1104
+ /**
1105
+ * The resolved absolute timestamp (ISO 8601, UTC) at which the task is
1106
+ * armed to run. Set by the backend when the schedule is armed and the
1107
+ * task transitions to SCHEDULED. Absent while the task is still
1108
+ * pending/unscheduled.
1109
+ *
1110
+ * Note: intentionally typed as plain `string` (not
1111
+ * `format: date-time`). `schedule` is embedded in the AutomationTask /
1112
+ * DecisionTask schemas; if a future request body ever accepts a task
1113
+ * (or schedule) and `safeParse`s it, `format: date-time` would make
1114
+ * openapi-zod-client emit `z.string().datetime({ offset: true })` and
1115
+ * reject any round-tripped value that is empty or tz-less — the exact
1116
+ * mechanism behind the May 2026 due_date incident (513ed597 added the
1117
+ * format, ee574b43 activated it via an unrelated regen; see commit
1118
+ * 2c91ff35). This field is server-written via `toISOString()` so it is
1119
+ * always a valid UTC instant; the datetime validator adds no
1120
+ * protection, only latent risk.
1121
+ *
1122
+ */
1123
+ scheduled_at?: string;
977
1124
  }
978
1125
  export interface SearchExecutionsReq {
979
1126
  name?: string;
@@ -1181,15 +1328,35 @@ declare namespace Components {
1181
1328
  assignedTo?: string[];
1182
1329
  }
1183
1330
  export type SectionStatus = "OPEN" | "IN_PROGRESS" | "COMPLETED";
1331
+ /**
1332
+ * Request payload for starting a new flow execution from a template.
1333
+ *
1334
+ */
1184
1335
  export interface StartFlowReq {
1336
+ /**
1337
+ * The unique identifier of the flow template (definition) to instantiate.
1338
+ * The template must exist and be accessible within the organization.
1339
+ *
1340
+ * example:
1341
+ * tpl_abc123def456
1342
+ */
1185
1343
  flow_template_id: string;
1186
1344
  trigger?: FlowTrigger;
1345
+ /**
1346
+ * Entity references that this execution is linked to. At least one context
1347
+ * is required. The primary context (is_primary: true) is used for condition
1348
+ * evaluation and data mapping.
1349
+ *
1350
+ */
1187
1351
  contexts: [
1188
1352
  FlowContext,
1189
1353
  ...FlowContext[]
1190
1354
  ];
1191
1355
  /**
1192
- * An array of purposes to filter workflow phases.
1356
+ * Taxonomy purpose IDs to filter which phases and tasks are included in the execution.
1357
+ * Only phases/tasks tagged with matching purposes will be active. If empty or omitted,
1358
+ * all phases and tasks from the template are included.
1359
+ *
1193
1360
  */
1194
1361
  purposes?: string[];
1195
1362
  }
@@ -1487,7 +1654,7 @@ declare namespace Components {
1487
1654
  }
1488
1655
  export type TaskId = string;
1489
1656
  export type TaskType = "MANUAL" | "AUTOMATION" | "DECISION" | "AI_AGENT";
1490
- export type TimeUnit = "minutes" | "hours" | "days" | "weeks" | "months";
1657
+ export type TimeUnit = "minutes" | "hours" | "days" | "weeks" | "months" | "years";
1491
1658
  export type TriggerMode = "manual" | "automatic";
1492
1659
  export type TriggerType = "MANUAL" | "AUTOMATIC";
1493
1660
  export interface UpdateEntityAttributes {
@@ -2001,9 +2168,24 @@ declare namespace Paths {
2001
2168
  export type RequestBody = Components.Schemas.AddTaskReq;
2002
2169
  namespace Responses {
2003
2170
  export type $201 = Components.Schemas.Task;
2004
- export type $400 = Components.Schemas.ErrorResp;
2005
- export type $401 = Components.Schemas.ErrorResp;
2006
- export type $500 = Components.Schemas.ErrorResp;
2171
+ export type $400 = /**
2172
+ * Standard error response returned when an API request fails.
2173
+ * Contains a human-readable message describing the error.
2174
+ *
2175
+ */
2176
+ Components.Schemas.ErrorResp;
2177
+ export type $401 = /**
2178
+ * Standard error response returned when an API request fails.
2179
+ * Contains a human-readable message describing the error.
2180
+ *
2181
+ */
2182
+ Components.Schemas.ErrorResp;
2183
+ export type $500 = /**
2184
+ * Standard error response returned when an API request fails.
2185
+ * Contains a human-readable message describing the error.
2186
+ *
2187
+ */
2188
+ Components.Schemas.ErrorResp;
2007
2189
  }
2008
2190
  }
2009
2191
  namespace CancelSchedule {
@@ -2018,10 +2200,30 @@ declare namespace Paths {
2018
2200
  namespace Responses {
2019
2201
  export interface $204 {
2020
2202
  }
2021
- export type $400 = Components.Schemas.ErrorResp;
2022
- export type $401 = Components.Schemas.ErrorResp;
2023
- export type $404 = Components.Schemas.ErrorResp;
2024
- export type $500 = Components.Schemas.ErrorResp;
2203
+ export type $400 = /**
2204
+ * Standard error response returned when an API request fails.
2205
+ * Contains a human-readable message describing the error.
2206
+ *
2207
+ */
2208
+ Components.Schemas.ErrorResp;
2209
+ export type $401 = /**
2210
+ * Standard error response returned when an API request fails.
2211
+ * Contains a human-readable message describing the error.
2212
+ *
2213
+ */
2214
+ Components.Schemas.ErrorResp;
2215
+ export type $404 = /**
2216
+ * Standard error response returned when an API request fails.
2217
+ * Contains a human-readable message describing the error.
2218
+ *
2219
+ */
2220
+ Components.Schemas.ErrorResp;
2221
+ export type $500 = /**
2222
+ * Standard error response returned when an API request fails.
2223
+ * Contains a human-readable message describing the error.
2224
+ *
2225
+ */
2226
+ Components.Schemas.ErrorResp;
2025
2227
  }
2026
2228
  }
2027
2229
  namespace CancelTaskSchedule {
@@ -2036,10 +2238,30 @@ declare namespace Paths {
2036
2238
  namespace Responses {
2037
2239
  export interface $204 {
2038
2240
  }
2039
- export type $400 = Components.Schemas.ErrorResp;
2040
- export type $401 = Components.Schemas.ErrorResp;
2041
- export type $404 = Components.Schemas.ErrorResp;
2042
- export type $500 = Components.Schemas.ErrorResp;
2241
+ export type $400 = /**
2242
+ * Standard error response returned when an API request fails.
2243
+ * Contains a human-readable message describing the error.
2244
+ *
2245
+ */
2246
+ Components.Schemas.ErrorResp;
2247
+ export type $401 = /**
2248
+ * Standard error response returned when an API request fails.
2249
+ * Contains a human-readable message describing the error.
2250
+ *
2251
+ */
2252
+ Components.Schemas.ErrorResp;
2253
+ export type $404 = /**
2254
+ * Standard error response returned when an API request fails.
2255
+ * Contains a human-readable message describing the error.
2256
+ *
2257
+ */
2258
+ Components.Schemas.ErrorResp;
2259
+ export type $500 = /**
2260
+ * Standard error response returned when an API request fails.
2261
+ * Contains a human-readable message describing the error.
2262
+ *
2263
+ */
2264
+ Components.Schemas.ErrorResp;
2043
2265
  }
2044
2266
  }
2045
2267
  namespace CreateExecution {
@@ -2115,9 +2337,24 @@ declare namespace Paths {
2115
2337
  * }
2116
2338
  */
2117
2339
  Components.Schemas.WorkflowExecution;
2118
- export type $400 = Components.Schemas.ErrorResp;
2119
- export type $401 = Components.Schemas.ErrorResp;
2120
- export type $500 = Components.Schemas.ErrorResp;
2340
+ export type $400 = /**
2341
+ * Standard error response returned when an API request fails.
2342
+ * Contains a human-readable message describing the error.
2343
+ *
2344
+ */
2345
+ Components.Schemas.ErrorResp;
2346
+ export type $401 = /**
2347
+ * Standard error response returned when an API request fails.
2348
+ * Contains a human-readable message describing the error.
2349
+ *
2350
+ */
2351
+ Components.Schemas.ErrorResp;
2352
+ export type $500 = /**
2353
+ * Standard error response returned when an API request fails.
2354
+ * Contains a human-readable message describing the error.
2355
+ *
2356
+ */
2357
+ Components.Schemas.ErrorResp;
2121
2358
  }
2122
2359
  }
2123
2360
  namespace CreateStep {
@@ -2130,9 +2367,24 @@ declare namespace Paths {
2130
2367
  export type RequestBody = Components.Schemas.CreateStepReq;
2131
2368
  namespace Responses {
2132
2369
  export type $201 = Components.Schemas.Step;
2133
- export type $400 = Components.Schemas.ErrorResp;
2134
- export type $401 = Components.Schemas.ErrorResp;
2135
- export type $500 = Components.Schemas.ErrorResp;
2370
+ export type $400 = /**
2371
+ * Standard error response returned when an API request fails.
2372
+ * Contains a human-readable message describing the error.
2373
+ *
2374
+ */
2375
+ Components.Schemas.ErrorResp;
2376
+ export type $401 = /**
2377
+ * Standard error response returned when an API request fails.
2378
+ * Contains a human-readable message describing the error.
2379
+ *
2380
+ */
2381
+ Components.Schemas.ErrorResp;
2382
+ export type $500 = /**
2383
+ * Standard error response returned when an API request fails.
2384
+ * Contains a human-readable message describing the error.
2385
+ *
2386
+ */
2387
+ Components.Schemas.ErrorResp;
2136
2388
  }
2137
2389
  }
2138
2390
  namespace DeleteExecution {
@@ -2145,7 +2397,12 @@ declare namespace Paths {
2145
2397
  namespace Responses {
2146
2398
  export interface $204 {
2147
2399
  }
2148
- export type $401 = Components.Schemas.ErrorResp;
2400
+ export type $401 = /**
2401
+ * Standard error response returned when an API request fails.
2402
+ * Contains a human-readable message describing the error.
2403
+ *
2404
+ */
2405
+ Components.Schemas.ErrorResp;
2149
2406
  export interface $404 {
2150
2407
  }
2151
2408
  }
@@ -2184,7 +2441,12 @@ declare namespace Paths {
2184
2441
  namespace Responses {
2185
2442
  export interface $204 {
2186
2443
  }
2187
- export type $500 = Components.Schemas.ErrorResp;
2444
+ export type $500 = /**
2445
+ * Standard error response returned when an API request fails.
2446
+ * Contains a human-readable message describing the error.
2447
+ *
2448
+ */
2449
+ Components.Schemas.ErrorResp;
2188
2450
  }
2189
2451
  }
2190
2452
  namespace ExecuteTask {
@@ -2198,9 +2460,24 @@ declare namespace Paths {
2198
2460
  }
2199
2461
  namespace Responses {
2200
2462
  export type $200 = Components.Schemas.Task;
2201
- export type $400 = Components.Schemas.ErrorResp;
2202
- export type $401 = Components.Schemas.ErrorResp;
2203
- export type $500 = Components.Schemas.ErrorResp;
2463
+ export type $400 = /**
2464
+ * Standard error response returned when an API request fails.
2465
+ * Contains a human-readable message describing the error.
2466
+ *
2467
+ */
2468
+ Components.Schemas.ErrorResp;
2469
+ export type $401 = /**
2470
+ * Standard error response returned when an API request fails.
2471
+ * Contains a human-readable message describing the error.
2472
+ *
2473
+ */
2474
+ Components.Schemas.ErrorResp;
2475
+ export type $500 = /**
2476
+ * Standard error response returned when an API request fails.
2477
+ * Contains a human-readable message describing the error.
2478
+ *
2479
+ */
2480
+ Components.Schemas.ErrorResp;
2204
2481
  }
2205
2482
  }
2206
2483
  namespace GetClosingReasonExecution {
@@ -2212,7 +2489,12 @@ declare namespace Paths {
2212
2489
  }
2213
2490
  namespace Responses {
2214
2491
  export type $200 = Components.Schemas.ClosingReasonResp;
2215
- export type $500 = Components.Schemas.ErrorResp;
2492
+ export type $500 = /**
2493
+ * Standard error response returned when an API request fails.
2494
+ * Contains a human-readable message describing the error.
2495
+ *
2496
+ */
2497
+ Components.Schemas.ErrorResp;
2216
2498
  }
2217
2499
  }
2218
2500
  namespace GetExecution {
@@ -2276,7 +2558,12 @@ declare namespace Paths {
2276
2558
  * }
2277
2559
  */
2278
2560
  Components.Schemas.WorkflowExecution;
2279
- export type $500 = Components.Schemas.ErrorResp;
2561
+ export type $500 = /**
2562
+ * Standard error response returned when an API request fails.
2563
+ * Contains a human-readable message describing the error.
2564
+ *
2565
+ */
2566
+ Components.Schemas.ErrorResp;
2280
2567
  }
2281
2568
  }
2282
2569
  namespace GetExecutions {
@@ -2333,7 +2620,12 @@ declare namespace Paths {
2333
2620
  * }
2334
2621
  */
2335
2622
  Components.Schemas.WorkflowExecutionSlim[];
2336
- export type $500 = Components.Schemas.ErrorResp;
2623
+ export type $500 = /**
2624
+ * Standard error response returned when an API request fails.
2625
+ * Contains a human-readable message describing the error.
2626
+ *
2627
+ */
2628
+ Components.Schemas.ErrorResp;
2337
2629
  }
2338
2630
  }
2339
2631
  namespace GetFlowExecution {
@@ -2369,7 +2661,12 @@ declare namespace Paths {
2369
2661
  }
2370
2662
  export interface $404 {
2371
2663
  }
2372
- export type $500 = Components.Schemas.ErrorResp;
2664
+ export type $500 = /**
2665
+ * Standard error response returned when an API request fails.
2666
+ * Contains a human-readable message describing the error.
2667
+ *
2668
+ */
2669
+ Components.Schemas.ErrorResp;
2373
2670
  }
2374
2671
  }
2375
2672
  namespace PatchPhase {
@@ -2384,9 +2681,24 @@ declare namespace Paths {
2384
2681
  export type RequestBody = Components.Schemas.PatchPhaseReq;
2385
2682
  namespace Responses {
2386
2683
  export type $200 = Components.Schemas.Phase;
2387
- export type $400 = Components.Schemas.ErrorResp;
2388
- export type $401 = Components.Schemas.ErrorResp;
2389
- export type $500 = Components.Schemas.ErrorResp;
2684
+ export type $400 = /**
2685
+ * Standard error response returned when an API request fails.
2686
+ * Contains a human-readable message describing the error.
2687
+ *
2688
+ */
2689
+ Components.Schemas.ErrorResp;
2690
+ export type $401 = /**
2691
+ * Standard error response returned when an API request fails.
2692
+ * Contains a human-readable message describing the error.
2693
+ *
2694
+ */
2695
+ Components.Schemas.ErrorResp;
2696
+ export type $500 = /**
2697
+ * Standard error response returned when an API request fails.
2698
+ * Contains a human-readable message describing the error.
2699
+ *
2700
+ */
2701
+ Components.Schemas.ErrorResp;
2390
2702
  }
2391
2703
  }
2392
2704
  namespace PatchTask {
@@ -2398,12 +2710,81 @@ declare namespace Paths {
2398
2710
  execution_id: Parameters.ExecutionId;
2399
2711
  task_id: Parameters.TaskId;
2400
2712
  }
2401
- export type RequestBody = Components.Schemas.PatchTaskReq;
2713
+ export type RequestBody = /**
2714
+ * Request payload for updating a task within a flow execution.
2715
+ * All fields are optional; only provided fields will be updated.
2716
+ *
2717
+ */
2718
+ Components.Schemas.PatchTaskReq;
2402
2719
  namespace Responses {
2403
2720
  export type $200 = Components.Schemas.Task;
2404
- export type $400 = Components.Schemas.ErrorResp;
2405
- export type $401 = Components.Schemas.ErrorResp;
2406
- export type $500 = Components.Schemas.ErrorResp;
2721
+ export type $400 = /**
2722
+ * Standard error response returned when an API request fails.
2723
+ * Contains a human-readable message describing the error.
2724
+ *
2725
+ */
2726
+ Components.Schemas.ErrorResp;
2727
+ export type $401 = /**
2728
+ * Standard error response returned when an API request fails.
2729
+ * Contains a human-readable message describing the error.
2730
+ *
2731
+ */
2732
+ Components.Schemas.ErrorResp;
2733
+ export type $404 = /**
2734
+ * Standard error response returned when an API request fails.
2735
+ * Contains a human-readable message describing the error.
2736
+ *
2737
+ */
2738
+ Components.Schemas.ErrorResp;
2739
+ export type $500 = /**
2740
+ * Standard error response returned when an API request fails.
2741
+ * Contains a human-readable message describing the error.
2742
+ *
2743
+ */
2744
+ Components.Schemas.ErrorResp;
2745
+ }
2746
+ }
2747
+ namespace ReconcileAutomationTask {
2748
+ namespace Parameters {
2749
+ export type ExecutionId = string;
2750
+ export type TaskId = string;
2751
+ }
2752
+ export interface PathParameters {
2753
+ execution_id: Parameters.ExecutionId;
2754
+ task_id: Parameters.TaskId;
2755
+ }
2756
+ namespace Responses {
2757
+ export type $200 = Components.Schemas.FlowExecution;
2758
+ export type $400 = /**
2759
+ * Standard error response returned when an API request fails.
2760
+ * Contains a human-readable message describing the error.
2761
+ *
2762
+ */
2763
+ Components.Schemas.ErrorResp;
2764
+ export type $401 = /**
2765
+ * Standard error response returned when an API request fails.
2766
+ * Contains a human-readable message describing the error.
2767
+ *
2768
+ */
2769
+ Components.Schemas.ErrorResp;
2770
+ export type $403 = /**
2771
+ * Standard error response returned when an API request fails.
2772
+ * Contains a human-readable message describing the error.
2773
+ *
2774
+ */
2775
+ Components.Schemas.ErrorResp;
2776
+ export type $404 = /**
2777
+ * Standard error response returned when an API request fails.
2778
+ * Contains a human-readable message describing the error.
2779
+ *
2780
+ */
2781
+ Components.Schemas.ErrorResp;
2782
+ export type $500 = /**
2783
+ * Standard error response returned when an API request fails.
2784
+ * Contains a human-readable message describing the error.
2785
+ *
2786
+ */
2787
+ Components.Schemas.ErrorResp;
2407
2788
  }
2408
2789
  }
2409
2790
  namespace RunTaskAutomation {
@@ -2417,9 +2798,24 @@ declare namespace Paths {
2417
2798
  }
2418
2799
  namespace Responses {
2419
2800
  export type $200 = Components.Schemas.AutomationTask;
2420
- export type $400 = Components.Schemas.ErrorResp;
2421
- export type $401 = Components.Schemas.ErrorResp;
2422
- export type $500 = Components.Schemas.ErrorResp;
2801
+ export type $400 = /**
2802
+ * Standard error response returned when an API request fails.
2803
+ * Contains a human-readable message describing the error.
2804
+ *
2805
+ */
2806
+ Components.Schemas.ErrorResp;
2807
+ export type $401 = /**
2808
+ * Standard error response returned when an API request fails.
2809
+ * Contains a human-readable message describing the error.
2810
+ *
2811
+ */
2812
+ Components.Schemas.ErrorResp;
2813
+ export type $500 = /**
2814
+ * Standard error response returned when an API request fails.
2815
+ * Contains a human-readable message describing the error.
2816
+ *
2817
+ */
2818
+ Components.Schemas.ErrorResp;
2423
2819
  }
2424
2820
  }
2425
2821
  namespace RunTaskScheduleNow {
@@ -2433,19 +2829,54 @@ declare namespace Paths {
2433
2829
  }
2434
2830
  namespace Responses {
2435
2831
  export type $200 = Components.Schemas.Task;
2436
- export type $400 = Components.Schemas.ErrorResp;
2437
- export type $401 = Components.Schemas.ErrorResp;
2438
- export type $404 = Components.Schemas.ErrorResp;
2439
- export type $500 = Components.Schemas.ErrorResp;
2832
+ export type $400 = /**
2833
+ * Standard error response returned when an API request fails.
2834
+ * Contains a human-readable message describing the error.
2835
+ *
2836
+ */
2837
+ Components.Schemas.ErrorResp;
2838
+ export type $401 = /**
2839
+ * Standard error response returned when an API request fails.
2840
+ * Contains a human-readable message describing the error.
2841
+ *
2842
+ */
2843
+ Components.Schemas.ErrorResp;
2844
+ export type $404 = /**
2845
+ * Standard error response returned when an API request fails.
2846
+ * Contains a human-readable message describing the error.
2847
+ *
2848
+ */
2849
+ Components.Schemas.ErrorResp;
2850
+ export type $500 = /**
2851
+ * Standard error response returned when an API request fails.
2852
+ * Contains a human-readable message describing the error.
2853
+ *
2854
+ */
2855
+ Components.Schemas.ErrorResp;
2440
2856
  }
2441
2857
  }
2442
2858
  namespace SearchExecutions {
2443
2859
  export type RequestBody = Components.Schemas.SearchExecutionsReq;
2444
2860
  namespace Responses {
2445
2861
  export type $200 = Components.Schemas.SearchExecutionsResp;
2446
- export type $400 = Components.Schemas.ErrorResp;
2447
- export type $401 = Components.Schemas.ErrorResp;
2448
- export type $500 = Components.Schemas.ErrorResp;
2862
+ export type $400 = /**
2863
+ * Standard error response returned when an API request fails.
2864
+ * Contains a human-readable message describing the error.
2865
+ *
2866
+ */
2867
+ Components.Schemas.ErrorResp;
2868
+ export type $401 = /**
2869
+ * Standard error response returned when an API request fails.
2870
+ * Contains a human-readable message describing the error.
2871
+ *
2872
+ */
2873
+ Components.Schemas.ErrorResp;
2874
+ export type $500 = /**
2875
+ * Standard error response returned when an API request fails.
2876
+ * Contains a human-readable message describing the error.
2877
+ *
2878
+ */
2879
+ Components.Schemas.ErrorResp;
2449
2880
  }
2450
2881
  }
2451
2882
  namespace SearchFlowExecutions {
@@ -2454,33 +2885,80 @@ declare namespace Paths {
2454
2885
  export interface $200 {
2455
2886
  results?: Components.Schemas.FlowExecution[];
2456
2887
  }
2457
- export type $400 = Components.Schemas.ErrorResp;
2888
+ export type $400 = /**
2889
+ * Standard error response returned when an API request fails.
2890
+ * Contains a human-readable message describing the error.
2891
+ *
2892
+ */
2893
+ Components.Schemas.ErrorResp;
2458
2894
  export interface $401 {
2459
2895
  }
2460
2896
  export interface $403 {
2461
2897
  }
2462
- export type $500 = Components.Schemas.ErrorResp;
2898
+ export type $500 = /**
2899
+ * Standard error response returned when an API request fails.
2900
+ * Contains a human-readable message describing the error.
2901
+ *
2902
+ */
2903
+ Components.Schemas.ErrorResp;
2463
2904
  }
2464
2905
  }
2465
2906
  namespace SearchSteps {
2466
2907
  export type RequestBody = Components.Schemas.SearchStepsReq;
2467
2908
  namespace Responses {
2468
2909
  export type $200 = Components.Schemas.SearchStepsResp;
2469
- export type $400 = Components.Schemas.ErrorResp;
2470
- export type $401 = Components.Schemas.ErrorResp;
2471
- export type $500 = Components.Schemas.ErrorResp;
2910
+ export type $400 = /**
2911
+ * Standard error response returned when an API request fails.
2912
+ * Contains a human-readable message describing the error.
2913
+ *
2914
+ */
2915
+ Components.Schemas.ErrorResp;
2916
+ export type $401 = /**
2917
+ * Standard error response returned when an API request fails.
2918
+ * Contains a human-readable message describing the error.
2919
+ *
2920
+ */
2921
+ Components.Schemas.ErrorResp;
2922
+ export type $500 = /**
2923
+ * Standard error response returned when an API request fails.
2924
+ * Contains a human-readable message describing the error.
2925
+ *
2926
+ */
2927
+ Components.Schemas.ErrorResp;
2472
2928
  }
2473
2929
  }
2474
2930
  namespace StartFlowExecution {
2475
- export type RequestBody = Components.Schemas.StartFlowReq;
2931
+ export type RequestBody = /**
2932
+ * Request payload for starting a new flow execution from a template.
2933
+ *
2934
+ */
2935
+ Components.Schemas.StartFlowReq;
2476
2936
  namespace Responses {
2477
2937
  export type $201 = Components.Schemas.FlowExecution;
2478
- export type $400 = Components.Schemas.ErrorResp;
2479
- export interface $401 {
2480
- }
2481
- export interface $403 {
2482
- }
2483
- export type $500 = Components.Schemas.ErrorResp;
2938
+ export type $400 = /**
2939
+ * Standard error response returned when an API request fails.
2940
+ * Contains a human-readable message describing the error.
2941
+ *
2942
+ */
2943
+ Components.Schemas.ErrorResp;
2944
+ export type $401 = /**
2945
+ * Standard error response returned when an API request fails.
2946
+ * Contains a human-readable message describing the error.
2947
+ *
2948
+ */
2949
+ Components.Schemas.ErrorResp;
2950
+ export type $403 = /**
2951
+ * Standard error response returned when an API request fails.
2952
+ * Contains a human-readable message describing the error.
2953
+ *
2954
+ */
2955
+ Components.Schemas.ErrorResp;
2956
+ export type $500 = /**
2957
+ * Standard error response returned when an API request fails.
2958
+ * Contains a human-readable message describing the error.
2959
+ *
2960
+ */
2961
+ Components.Schemas.ErrorResp;
2484
2962
  }
2485
2963
  }
2486
2964
  namespace UpdateExecution {
@@ -2494,7 +2972,12 @@ declare namespace Paths {
2494
2972
  namespace Responses {
2495
2973
  export interface $204 {
2496
2974
  }
2497
- export type $500 = Components.Schemas.ErrorResp;
2975
+ export type $500 = /**
2976
+ * Standard error response returned when an API request fails.
2977
+ * Contains a human-readable message describing the error.
2978
+ *
2979
+ */
2980
+ Components.Schemas.ErrorResp;
2498
2981
  }
2499
2982
  }
2500
2983
  namespace UpdateStep {
@@ -2509,9 +2992,24 @@ declare namespace Paths {
2509
2992
  export type RequestBody = Components.Schemas.UpdateStepReq;
2510
2993
  namespace Responses {
2511
2994
  export type $200 = Components.Schemas.Step;
2512
- export type $400 = Components.Schemas.ErrorResp;
2513
- export type $401 = Components.Schemas.ErrorResp;
2514
- export type $500 = Components.Schemas.ErrorResp;
2995
+ export type $400 = /**
2996
+ * Standard error response returned when an API request fails.
2997
+ * Contains a human-readable message describing the error.
2998
+ *
2999
+ */
3000
+ Components.Schemas.ErrorResp;
3001
+ export type $401 = /**
3002
+ * Standard error response returned when an API request fails.
3003
+ * Contains a human-readable message describing the error.
3004
+ *
3005
+ */
3006
+ Components.Schemas.ErrorResp;
3007
+ export type $500 = /**
3008
+ * Standard error response returned when an API request fails.
3009
+ * Contains a human-readable message describing the error.
3010
+ *
3011
+ */
3012
+ Components.Schemas.ErrorResp;
2515
3013
  }
2516
3014
  }
2517
3015
  }
@@ -2531,7 +3029,13 @@ interface OperationMethods {
2531
3029
  /**
2532
3030
  * createExecution - createExecution
2533
3031
  *
2534
- * Create a Workflow Execution. Start a new workflow execution, based on a workflow definition (template).
3032
+ * Creates a new V1 Workflow Execution from a workflow definition (template).
3033
+ *
3034
+ * **Note:** This is the legacy V1 API. For new integrations, use `POST /v2/flows/executions` instead.
3035
+ *
3036
+ * The workflow definition specifies the structure (sections and steps) of the workflow.
3037
+ * When created, the execution instantiates all steps and begins tracking progress.
3038
+ *
2535
3039
  */
2536
3040
  'createExecution'(
2537
3041
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -2541,7 +3045,10 @@ interface OperationMethods {
2541
3045
  /**
2542
3046
  * getExecution - getExecution
2543
3047
  *
2544
- * Get a full workflow execution, included steps information, by execution id.
3048
+ * Retrieves a complete V1 workflow execution by ID, including all steps information.
3049
+ *
3050
+ * **Note:** This is the legacy V1 API. For new integrations, use `GET /v2/flows/executions/{execution_id}` instead.
3051
+ *
2545
3052
  */
2546
3053
  'getExecution'(
2547
3054
  parameters?: Parameters<Paths.GetExecution.PathParameters> | null,
@@ -2581,7 +3088,16 @@ interface OperationMethods {
2581
3088
  /**
2582
3089
  * updateStep - updateStep
2583
3090
  *
2584
- * Patches various changes to a workflow execution step.
3091
+ * Updates a workflow execution step with new values for status, assignees, due date, position, and more.
3092
+ *
3093
+ * **Note:** This is the legacy V1 API. For new integrations, use `PATCH /v2/flows/executions/{execution_id}/tasks/{task_id}` instead.
3094
+ *
3095
+ * **Common use cases:**
3096
+ * - Mark a step as completed or skipped
3097
+ * - Assign or reassign users to a step
3098
+ * - Update step due dates (static or dynamic)
3099
+ * - Reorder steps within a section
3100
+ *
2585
3101
  */
2586
3102
  'updateStep'(
2587
3103
  parameters?: Parameters<Paths.UpdateStep.PathParameters> | null,
@@ -2634,7 +3150,20 @@ interface OperationMethods {
2634
3150
  /**
2635
3151
  * startFlowExecution - startFlowExecution
2636
3152
  *
2637
- * Starts a new Flow Execution based on a flow template.
3153
+ * Starts a new Flow Execution based on a flow template (definition).
3154
+ *
3155
+ * The flow template defines the structure of the workflow including phases, tasks, edges (transitions),
3156
+ * and automation configurations. When started, the execution creates runtime instances of all tasks
3157
+ * and begins processing from the initial task(s).
3158
+ *
3159
+ * **Required fields:**
3160
+ * - `flow_template_id`: The ID of the flow template to instantiate
3161
+ * - `contexts`: At least one entity context to link the execution to
3162
+ *
3163
+ * **Optional fields:**
3164
+ * - `trigger`: Specifies how the execution was triggered (manual or automatic)
3165
+ * - `purposes`: Filter which phases/tasks are included based on taxonomy purposes
3166
+ *
2638
3167
  */
2639
3168
  'startFlowExecution'(
2640
3169
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -2644,7 +3173,16 @@ interface OperationMethods {
2644
3173
  /**
2645
3174
  * getFlowExecution - getFlowExecution
2646
3175
  *
2647
- * Get a full flow execution, included tasks, phases, edges & analytics.
3176
+ * Retrieves a complete flow execution by ID, including all phases, tasks, edges, contexts, and analytics.
3177
+ *
3178
+ * The response includes:
3179
+ * - **Execution metadata**: ID, name, status, timestamps, assignees
3180
+ * - **Phases**: Organizational groupings of tasks with progress tracking
3181
+ * - **Tasks**: Individual work items with their status, assignees, and configurations
3182
+ * - **Edges**: Connections between tasks defining the workflow graph
3183
+ * - **Analytics**: Timing information (started, completed, closed timestamps)
3184
+ * - **Contexts**: Linked entity references
3185
+ *
2648
3186
  */
2649
3187
  'getFlowExecution'(
2650
3188
  parameters?: Parameters<Paths.GetFlowExecution.PathParameters> | null,
@@ -2684,7 +3222,26 @@ interface OperationMethods {
2684
3222
  /**
2685
3223
  * patchTask - patchTask
2686
3224
  *
2687
- * Changes various attributes of a flow task, like assignees, status, due date, etc.
3225
+ * Updates attributes of a flow task including status, assignees, due date, and more.
3226
+ *
3227
+ * **Common use cases:**
3228
+ * - Mark a task as completed or skipped
3229
+ * - Assign or reassign users to a task
3230
+ * - Update task due dates
3231
+ * - Enable or disable a task
3232
+ * - Revert execution to a previous task
3233
+ *
3234
+ * **Status transitions:**
3235
+ * - `PENDING` -> `IN_PROGRESS`: User starts working on the task
3236
+ * - `IN_PROGRESS` -> `COMPLETED`: User finishes the task
3237
+ * - `PENDING` or `IN_PROGRESS` -> `SKIPPED`: Task is bypassed
3238
+ * - `COMPLETED` or `SKIPPED` -> `PENDING`: Task is reopened (with revert_execution flag)
3239
+ *
3240
+ * **Reverting execution:**
3241
+ * When updating a task that was already completed/skipped and comes before the current task,
3242
+ * use `revert_execution: true` to reset the flow back to that point. All subsequent tasks
3243
+ * will be reset to PENDING status.
3244
+ *
2688
3245
  */
2689
3246
  'patchTask'(
2690
3247
  parameters?: Parameters<Paths.PatchTask.PathParameters> | null,
@@ -2741,6 +3298,29 @@ interface OperationMethods {
2741
3298
  data?: any,
2742
3299
  config?: AxiosRequestConfig
2743
3300
  ): OperationResponse<Paths.CancelTaskSchedule.Responses.$204>
3301
+ /**
3302
+ * reconcileAutomationTask - reconcileAutomationTask
3303
+ *
3304
+ * Reconciles an automation task's status against its linked automation execution.
3305
+ *
3306
+ * Looks the task up by id (whether or not it is currently a `crt_task`),
3307
+ * fetches its automation execution, and — if the automation has reached a
3308
+ * terminal state (success/failed/skipped) — corrects the task's `status`,
3309
+ * `automation_config` and `analytics` to match and persists them. If the
3310
+ * task is the current task and the flow is still active, the flow is
3311
+ * advanced; otherwise only the task record is corrected.
3312
+ *
3313
+ * Used by the "Refresh status" action to recover a task left `IN_PROGRESS`
3314
+ * after a missed or clobbered completion event. No-op (returns the
3315
+ * execution unchanged) when the task is already terminal or the automation
3316
+ * is still running.
3317
+ *
3318
+ */
3319
+ 'reconcileAutomationTask'(
3320
+ parameters?: Parameters<Paths.ReconcileAutomationTask.PathParameters> | null,
3321
+ data?: any,
3322
+ config?: AxiosRequestConfig
3323
+ ): OperationResponse<Paths.ReconcileAutomationTask.Responses.$200>
2744
3324
  /**
2745
3325
  * runTaskScheduleNow - runTaskScheduleNow
2746
3326
  *
@@ -2781,7 +3361,13 @@ interface PathsDictionary {
2781
3361
  /**
2782
3362
  * createExecution - createExecution
2783
3363
  *
2784
- * Create a Workflow Execution. Start a new workflow execution, based on a workflow definition (template).
3364
+ * Creates a new V1 Workflow Execution from a workflow definition (template).
3365
+ *
3366
+ * **Note:** This is the legacy V1 API. For new integrations, use `POST /v2/flows/executions` instead.
3367
+ *
3368
+ * The workflow definition specifies the structure (sections and steps) of the workflow.
3369
+ * When created, the execution instantiates all steps and begins tracking progress.
3370
+ *
2785
3371
  */
2786
3372
  'post'(
2787
3373
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -2793,7 +3379,10 @@ interface PathsDictionary {
2793
3379
  /**
2794
3380
  * getExecution - getExecution
2795
3381
  *
2796
- * Get a full workflow execution, included steps information, by execution id.
3382
+ * Retrieves a complete V1 workflow execution by ID, including all steps information.
3383
+ *
3384
+ * **Note:** This is the legacy V1 API. For new integrations, use `GET /v2/flows/executions/{execution_id}` instead.
3385
+ *
2797
3386
  */
2798
3387
  'get'(
2799
3388
  parameters?: Parameters<Paths.GetExecution.PathParameters> | null,
@@ -2837,7 +3426,16 @@ interface PathsDictionary {
2837
3426
  /**
2838
3427
  * updateStep - updateStep
2839
3428
  *
2840
- * Patches various changes to a workflow execution step.
3429
+ * Updates a workflow execution step with new values for status, assignees, due date, position, and more.
3430
+ *
3431
+ * **Note:** This is the legacy V1 API. For new integrations, use `PATCH /v2/flows/executions/{execution_id}/tasks/{task_id}` instead.
3432
+ *
3433
+ * **Common use cases:**
3434
+ * - Mark a step as completed or skipped
3435
+ * - Assign or reassign users to a step
3436
+ * - Update step due dates (static or dynamic)
3437
+ * - Reorder steps within a section
3438
+ *
2841
3439
  */
2842
3440
  'patch'(
2843
3441
  parameters?: Parameters<Paths.UpdateStep.PathParameters> | null,
@@ -2898,7 +3496,20 @@ interface PathsDictionary {
2898
3496
  /**
2899
3497
  * startFlowExecution - startFlowExecution
2900
3498
  *
2901
- * Starts a new Flow Execution based on a flow template.
3499
+ * Starts a new Flow Execution based on a flow template (definition).
3500
+ *
3501
+ * The flow template defines the structure of the workflow including phases, tasks, edges (transitions),
3502
+ * and automation configurations. When started, the execution creates runtime instances of all tasks
3503
+ * and begins processing from the initial task(s).
3504
+ *
3505
+ * **Required fields:**
3506
+ * - `flow_template_id`: The ID of the flow template to instantiate
3507
+ * - `contexts`: At least one entity context to link the execution to
3508
+ *
3509
+ * **Optional fields:**
3510
+ * - `trigger`: Specifies how the execution was triggered (manual or automatic)
3511
+ * - `purposes`: Filter which phases/tasks are included based on taxonomy purposes
3512
+ *
2902
3513
  */
2903
3514
  'post'(
2904
3515
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -2910,7 +3521,16 @@ interface PathsDictionary {
2910
3521
  /**
2911
3522
  * getFlowExecution - getFlowExecution
2912
3523
  *
2913
- * Get a full flow execution, included tasks, phases, edges & analytics.
3524
+ * Retrieves a complete flow execution by ID, including all phases, tasks, edges, contexts, and analytics.
3525
+ *
3526
+ * The response includes:
3527
+ * - **Execution metadata**: ID, name, status, timestamps, assignees
3528
+ * - **Phases**: Organizational groupings of tasks with progress tracking
3529
+ * - **Tasks**: Individual work items with their status, assignees, and configurations
3530
+ * - **Edges**: Connections between tasks defining the workflow graph
3531
+ * - **Analytics**: Timing information (started, completed, closed timestamps)
3532
+ * - **Contexts**: Linked entity references
3533
+ *
2914
3534
  */
2915
3535
  'get'(
2916
3536
  parameters?: Parameters<Paths.GetFlowExecution.PathParameters> | null,
@@ -2954,7 +3574,26 @@ interface PathsDictionary {
2954
3574
  /**
2955
3575
  * patchTask - patchTask
2956
3576
  *
2957
- * Changes various attributes of a flow task, like assignees, status, due date, etc.
3577
+ * Updates attributes of a flow task including status, assignees, due date, and more.
3578
+ *
3579
+ * **Common use cases:**
3580
+ * - Mark a task as completed or skipped
3581
+ * - Assign or reassign users to a task
3582
+ * - Update task due dates
3583
+ * - Enable or disable a task
3584
+ * - Revert execution to a previous task
3585
+ *
3586
+ * **Status transitions:**
3587
+ * - `PENDING` -> `IN_PROGRESS`: User starts working on the task
3588
+ * - `IN_PROGRESS` -> `COMPLETED`: User finishes the task
3589
+ * - `PENDING` or `IN_PROGRESS` -> `SKIPPED`: Task is bypassed
3590
+ * - `COMPLETED` or `SKIPPED` -> `PENDING`: Task is reopened (with revert_execution flag)
3591
+ *
3592
+ * **Reverting execution:**
3593
+ * When updating a task that was already completed/skipped and comes before the current task,
3594
+ * use `revert_execution: true` to reset the flow back to that point. All subsequent tasks
3595
+ * will be reset to PENDING status.
3596
+ *
2958
3597
  */
2959
3598
  'patch'(
2960
3599
  parameters?: Parameters<Paths.PatchTask.PathParameters> | null,
@@ -3022,6 +3661,31 @@ interface PathsDictionary {
3022
3661
  config?: AxiosRequestConfig
3023
3662
  ): OperationResponse<Paths.CancelTaskSchedule.Responses.$204>
3024
3663
  }
3664
+ ['/v2/flows/executions/{execution_id}/tasks/{task_id}/reconcile-automation']: {
3665
+ /**
3666
+ * reconcileAutomationTask - reconcileAutomationTask
3667
+ *
3668
+ * Reconciles an automation task's status against its linked automation execution.
3669
+ *
3670
+ * Looks the task up by id (whether or not it is currently a `crt_task`),
3671
+ * fetches its automation execution, and — if the automation has reached a
3672
+ * terminal state (success/failed/skipped) — corrects the task's `status`,
3673
+ * `automation_config` and `analytics` to match and persists them. If the
3674
+ * task is the current task and the flow is still active, the flow is
3675
+ * advanced; otherwise only the task record is corrected.
3676
+ *
3677
+ * Used by the "Refresh status" action to recover a task left `IN_PROGRESS`
3678
+ * after a missed or clobbered completion event. No-op (returns the
3679
+ * execution unchanged) when the task is already terminal or the automation
3680
+ * is still running.
3681
+ *
3682
+ */
3683
+ 'post'(
3684
+ parameters?: Parameters<Paths.ReconcileAutomationTask.PathParameters> | null,
3685
+ data?: any,
3686
+ config?: AxiosRequestConfig
3687
+ ): OperationResponse<Paths.ReconcileAutomationTask.Responses.$200>
3688
+ }
3025
3689
  ['/v2/flows/executions/{execution_id}/tasks/{task_id}/schedule/run-now']: {
3026
3690
  /**
3027
3691
  * runTaskScheduleNow - runTaskScheduleNow