@epilot/sdk 2.12.1 → 2.13.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (174) hide show
  1. package/definitions/customer-portal-runtime.json +1 -1
  2. package/definitions/customer-portal.json +164 -16
  3. package/definitions/focus-pocus-runtime.json +1 -0
  4. package/definitions/focus-pocus.json +757 -0
  5. package/definitions/user-runtime.json +1 -1
  6. package/definitions/user.json +146 -0
  7. package/definitions/workflow-definition-runtime.json +1 -1
  8. package/definitions/workflow-definition.json +281 -47
  9. package/definitions/workflow.json +12 -0
  10. package/dist/apis/access-token.cjs +6 -6
  11. package/dist/apis/access-token.js +1 -1
  12. package/dist/apis/address-suggestions.cjs +6 -6
  13. package/dist/apis/address-suggestions.js +1 -1
  14. package/dist/apis/address.cjs +6 -6
  15. package/dist/apis/address.js +1 -1
  16. package/dist/apis/ai-agents.cjs +6 -6
  17. package/dist/apis/ai-agents.js +1 -1
  18. package/dist/apis/app.cjs +6 -6
  19. package/dist/apis/app.js +1 -1
  20. package/dist/apis/audit-logs.cjs +6 -6
  21. package/dist/apis/audit-logs.js +1 -1
  22. package/dist/apis/automation.cjs +6 -6
  23. package/dist/apis/automation.js +1 -1
  24. package/dist/apis/billing.cjs +6 -6
  25. package/dist/apis/billing.js +1 -1
  26. package/dist/apis/blueprint-manifest.cjs +6 -6
  27. package/dist/apis/blueprint-manifest.js +1 -1
  28. package/dist/apis/calendar.cjs +6 -6
  29. package/dist/apis/calendar.js +1 -1
  30. package/dist/apis/configuration-hub.cjs +6 -6
  31. package/dist/apis/configuration-hub.js +1 -1
  32. package/dist/apis/consent.cjs +6 -6
  33. package/dist/apis/consent.js +1 -1
  34. package/dist/apis/customer-portal.cjs +8 -8
  35. package/dist/apis/customer-portal.d.cts +2 -2
  36. package/dist/apis/customer-portal.d.ts +2 -2
  37. package/dist/apis/customer-portal.js +2 -2
  38. package/dist/apis/dashboard.cjs +6 -6
  39. package/dist/apis/dashboard.js +1 -1
  40. package/dist/apis/data-governance.cjs +6 -6
  41. package/dist/apis/data-governance.js +1 -1
  42. package/dist/apis/deduplication.cjs +6 -6
  43. package/dist/apis/deduplication.js +1 -1
  44. package/dist/apis/design.cjs +6 -6
  45. package/dist/apis/design.js +1 -1
  46. package/dist/apis/document.cjs +6 -6
  47. package/dist/apis/document.js +1 -1
  48. package/dist/apis/email-settings.cjs +6 -6
  49. package/dist/apis/email-settings.js +1 -1
  50. package/dist/apis/email-template.cjs +6 -6
  51. package/dist/apis/email-template.js +1 -1
  52. package/dist/apis/entity-mapping.cjs +6 -6
  53. package/dist/apis/entity-mapping.js +1 -1
  54. package/dist/apis/entity.cjs +6 -6
  55. package/dist/apis/entity.js +1 -1
  56. package/dist/apis/environments.cjs +6 -6
  57. package/dist/apis/environments.js +1 -1
  58. package/dist/apis/event-catalog.cjs +6 -6
  59. package/dist/apis/event-catalog.js +1 -1
  60. package/dist/apis/file.cjs +6 -6
  61. package/dist/apis/file.js +1 -1
  62. package/dist/apis/iban.cjs +6 -6
  63. package/dist/apis/iban.js +1 -1
  64. package/dist/apis/integration-toolkit.cjs +6 -6
  65. package/dist/apis/integration-toolkit.js +1 -1
  66. package/dist/apis/journey.cjs +6 -6
  67. package/dist/apis/journey.js +1 -1
  68. package/dist/apis/kanban.cjs +6 -6
  69. package/dist/apis/kanban.js +1 -1
  70. package/dist/apis/message.cjs +6 -6
  71. package/dist/apis/message.js +1 -1
  72. package/dist/apis/metering.cjs +6 -6
  73. package/dist/apis/metering.js +1 -1
  74. package/dist/apis/notes.cjs +6 -6
  75. package/dist/apis/notes.js +1 -1
  76. package/dist/apis/notification.cjs +6 -6
  77. package/dist/apis/notification.js +1 -1
  78. package/dist/apis/organization.cjs +6 -6
  79. package/dist/apis/organization.js +1 -1
  80. package/dist/apis/partner-directory.cjs +6 -6
  81. package/dist/apis/partner-directory.js +1 -1
  82. package/dist/apis/permissions.cjs +6 -6
  83. package/dist/apis/permissions.js +1 -1
  84. package/dist/apis/pricing-tier.cjs +6 -6
  85. package/dist/apis/pricing-tier.js +1 -1
  86. package/dist/apis/pricing.cjs +6 -6
  87. package/dist/apis/pricing.js +1 -1
  88. package/dist/apis/purpose.cjs +6 -6
  89. package/dist/apis/purpose.js +1 -1
  90. package/dist/apis/query.cjs +6 -6
  91. package/dist/apis/query.js +1 -1
  92. package/dist/apis/sandbox.cjs +6 -6
  93. package/dist/apis/sandbox.js +1 -1
  94. package/dist/apis/sharing.cjs +6 -6
  95. package/dist/apis/sharing.js +1 -1
  96. package/dist/apis/snapshot.cjs +6 -6
  97. package/dist/apis/snapshot.js +1 -1
  98. package/dist/apis/submission.cjs +6 -6
  99. package/dist/apis/submission.js +1 -1
  100. package/dist/apis/target.cjs +6 -6
  101. package/dist/apis/target.js +1 -1
  102. package/dist/apis/targeting.cjs +6 -6
  103. package/dist/apis/targeting.js +1 -1
  104. package/dist/apis/template-variables.cjs +6 -6
  105. package/dist/apis/template-variables.js +1 -1
  106. package/dist/apis/user.cjs +8 -8
  107. package/dist/apis/user.d.cts +2 -2
  108. package/dist/apis/user.d.ts +2 -2
  109. package/dist/apis/user.js +2 -2
  110. package/dist/apis/validation-rules.cjs +6 -6
  111. package/dist/apis/validation-rules.js +1 -1
  112. package/dist/apis/webhooks.cjs +6 -6
  113. package/dist/apis/webhooks.js +1 -1
  114. package/dist/apis/workflow-definition.cjs +8 -8
  115. package/dist/apis/workflow-definition.d.cts +2 -2
  116. package/dist/apis/workflow-definition.d.ts +2 -2
  117. package/dist/apis/workflow-definition.js +2 -2
  118. package/dist/apis/workflow.cjs +6 -6
  119. package/dist/apis/workflow.d.cts +2 -2
  120. package/dist/apis/workflow.d.ts +2 -2
  121. package/dist/apis/workflow.js +1 -1
  122. package/dist/chunk-6HJ2Y7DZ.js +14 -0
  123. package/dist/chunk-BFMY2X2J.cjs +14 -0
  124. package/dist/{chunk-AJDY36Y6.cjs → chunk-C35OPQHY.cjs} +7 -7
  125. package/dist/{chunk-NFIYEMMM.js → chunk-N254AABZ.js} +1 -1
  126. package/dist/chunk-OSPTVXY4.js +14 -0
  127. package/dist/chunk-QNSMYDKG.cjs +14 -0
  128. package/dist/{chunk-L3UZLJPQ.js → chunk-SQQJND25.js} +7 -7
  129. package/dist/{chunk-OWXEZ56F.cjs → chunk-X2LMHC5R.cjs} +1 -1
  130. package/dist/customer-portal-6I3G44I4.cjs +7 -0
  131. package/dist/customer-portal-PTVGKDUH.js +7 -0
  132. package/dist/{customer-portal-runtime-VRGCSOVU.cjs → customer-portal-runtime-4ACQGDNY.cjs} +2 -2
  133. package/dist/{customer-portal-runtime-NRIQG6IO.js → customer-portal-runtime-E4RI7NYM.js} +1 -1
  134. package/dist/{customer-portal.d-fWVl8_mE.d.cts → customer-portal.d-Bpc-wk9K.d.cts} +140 -12
  135. package/dist/{customer-portal.d-fWVl8_mE.d.ts → customer-portal.d-Bpc-wk9K.d.ts} +140 -12
  136. package/dist/index.cjs +14 -14
  137. package/dist/index.d.cts +4 -4
  138. package/dist/index.d.ts +4 -4
  139. package/dist/index.js +4 -4
  140. package/dist/js-yaml-DLCVPJ7G.js +0 -0
  141. package/dist/user-5KLWGPQ2.js +7 -0
  142. package/dist/user-GZLPNGIW.cjs +7 -0
  143. package/dist/user-runtime-6TSL4RZN.cjs +5 -0
  144. package/dist/{user-runtime-6ICV2Y73.js → user-runtime-UPFER72E.js} +1 -1
  145. package/dist/{user.d-L-C7_K84.d.cts → user.d-6bp0zEwE.d.cts} +131 -0
  146. package/dist/{user.d-L-C7_K84.d.ts → user.d-6bp0zEwE.d.ts} +131 -0
  147. package/dist/workflow-JQT3F5NJ.cjs +7 -0
  148. package/dist/workflow-Q6FAE5OL.js +7 -0
  149. package/dist/workflow-definition-5P3PDJKU.cjs +7 -0
  150. package/dist/workflow-definition-XSSOSEGF.js +7 -0
  151. package/dist/{workflow-definition-runtime-GACBV4WM.cjs → workflow-definition-runtime-2HQS3RPK.cjs} +2 -2
  152. package/dist/{workflow-definition-runtime-OVXRSE34.js → workflow-definition-runtime-JUPATIKU.js} +1 -1
  153. package/dist/{workflow-definition.d-DOeb0KVV.d.cts → workflow-definition.d-CweGhhBU.d.cts} +416 -82
  154. package/dist/{workflow-definition.d-DOeb0KVV.d.ts → workflow-definition.d-CweGhhBU.d.ts} +416 -82
  155. package/dist/{workflow.d-eFv0ecBi.d.cts → workflow.d-5cyNJgVQ.d.cts} +28 -0
  156. package/dist/{workflow.d-eFv0ecBi.d.ts → workflow.d-5cyNJgVQ.d.ts} +28 -0
  157. package/docs/customer-portal.md +86 -21
  158. package/docs/user.md +174 -11
  159. package/docs/workflow-definition.md +179 -43
  160. package/docs/workflow.md +16 -7
  161. package/package.json +12 -11
  162. package/dist/chunk-43GJY2EB.js +0 -14
  163. package/dist/chunk-4H2KIKGL.cjs +0 -14
  164. package/dist/chunk-COASF7ZR.js +0 -14
  165. package/dist/chunk-CYS6QBW6.cjs +0 -14
  166. package/dist/customer-portal-F45XWLIO.cjs +0 -7
  167. package/dist/customer-portal-MYNJZ4OW.js +0 -7
  168. package/dist/user-3SLAEEVD.cjs +0 -7
  169. package/dist/user-PRUYBXQV.js +0 -7
  170. package/dist/user-runtime-Y3227ETX.cjs +0 -5
  171. package/dist/workflow-7OU2YEEI.cjs +0 -7
  172. package/dist/workflow-IVKCWS44.js +0 -7
  173. package/dist/workflow-definition-2VF7S23G.js +0 -7
  174. package/dist/workflow-definition-U6YXD42W.cjs +0 -7
@@ -4,6 +4,12 @@ import { OpenAPIClient, Parameters, UnknownParamsObject, AxiosRequestConfig, Ope
4
4
 
5
5
 
6
6
  declare namespace Components {
7
+ namespace Parameters {
8
+ export type EnforceLimitsParam = boolean;
9
+ }
10
+ export interface QueryParameters {
11
+ EnforceLimitsParam?: Parameters.EnforceLimitsParam;
12
+ }
7
13
  namespace Schemas {
8
14
  export type ActionSchedule = ImmediateSchedule | DelayedSchedule | RelativeSchedule;
9
15
  /**
@@ -178,9 +184,14 @@ declare namespace Components {
178
184
  id: string;
179
185
  }
180
186
  /**
181
- * Closing reason could be not found
187
+ * Error response returned when a closing reason is not found.
182
188
  */
183
189
  export interface ClosingReasonNotFoundResp {
190
+ /**
191
+ * Human-readable message indicating the closing reason was not found.
192
+ * example:
193
+ * Closing reason with id 'xyz789' not found
194
+ */
184
195
  message?: string;
185
196
  }
186
197
  export interface ClosingReasons {
@@ -201,10 +212,28 @@ declare namespace Components {
201
212
  logical_operator: "AND" | "OR";
202
213
  statements: Statement[] | null;
203
214
  }
215
+ /**
216
+ * Base schema for V2 flow templates. A flow template defines the structure of a workflow
217
+ * including phases, tasks, edges, triggers, and other configuration. Flow templates serve
218
+ * as blueprints that can be instantiated as flow executions.
219
+ *
220
+ */
204
221
  export interface CreateFlowTemplate {
222
+ /**
223
+ * Unique identifier for the flow template, generated by the system.
224
+ */
205
225
  id?: string;
226
+ /**
227
+ * Organization identifier that owns this flow template.
228
+ */
206
229
  org_id?: string;
230
+ /**
231
+ * Display name for the workflow, shown to users in the UI.
232
+ */
207
233
  name: string;
234
+ /**
235
+ * Optional detailed description of the workflow's purpose and behavior.
236
+ */
208
237
  description?: string;
209
238
  trigger?: /**
210
239
  * example:
@@ -295,6 +324,14 @@ declare namespace Components {
295
324
  * The manifest IDs associated with this workflow
296
325
  */
297
326
  _manifest?: string[];
327
+ /**
328
+ * When true, this is a linear flow: task enablement is computed at runtime from the graph — a task is enabled only when all of its direct predecessor tasks in its branch are done. This fully overrides any explicit per-task requirements.
329
+ */
330
+ linear?: boolean;
331
+ /**
332
+ * Non-blocking warnings for configuration limits the flow exceeds. Returned on read (get-flow) and on create/update responses. Size/count limits are soft: a flow exceeding them is still accepted and stored, and the violations are reported here so the UI can surface an informational banner. The flow is still fully editable and usable.
333
+ */
334
+ limit_warnings?: /* A 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 — only structural errors do. The flow remains fully usable; users are encouraged to bring values within the limits. */ FlowLimitWarning[];
298
335
  }
299
336
  export interface DecisionTask {
300
337
  id: string;
@@ -344,9 +381,14 @@ declare namespace Components {
344
381
  };
345
382
  }
346
383
  /**
347
- * Definition could be not found
384
+ * Error response returned when a workflow definition or flow template is not found.
348
385
  */
349
386
  export interface DefinitionNotFoundResp {
387
+ /**
388
+ * Human-readable message indicating the resource was not found.
389
+ * example:
390
+ * Definition with id 'abc123' not found
391
+ */
350
392
  message?: string;
351
393
  }
352
394
  export interface DelayedSchedule {
@@ -365,9 +407,16 @@ declare namespace Components {
365
407
  phase_id?: string;
366
408
  }
367
409
  /**
368
- * set a Duedate for a step then a specific
410
+ * Configuration for calculating a due date dynamically based on workflow events.
411
+ * The due date is computed by adding a duration (numberOfUnits + timePeriod) to
412
+ * a reference point defined by actionTypeCondition (e.g., when workflow started,
413
+ * when a step closed, or when a phase finished).
414
+ *
369
415
  */
370
416
  export interface DynamicDueDate {
417
+ /**
418
+ * Number of time units to add to the reference point.
419
+ */
371
420
  numberOfUnits: number;
372
421
  timePeriod: TimeUnit;
373
422
  actionTypeCondition: "WORKFLOW_STARTED" | "STEP_CLOSED" | "PHASE_FINISHED";
@@ -470,7 +519,15 @@ declare namespace Components {
470
519
  entityAttribute: string;
471
520
  };
472
521
  }
522
+ /**
523
+ * Standard error response returned when an API request fails.
524
+ */
473
525
  export interface ErrorResp {
526
+ /**
527
+ * Human-readable error message describing what went wrong.
528
+ * example:
529
+ * Invalid request body: name is required
530
+ */
474
531
  message?: string;
475
532
  }
476
533
  export interface EvaluationSource {
@@ -485,6 +542,34 @@ declare namespace Components {
485
542
  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";
486
543
  attribute_repeatable?: boolean;
487
544
  attribute_operation?: "all" | "updated" | "added" | "deleted";
545
+ /**
546
+ * Multi-attribute mode. When present and length > 1, the statement is
547
+ * evaluated against every listed attribute and combined via
548
+ * `attributes_match`. All listed attributes must share the same
549
+ * `attribute_type`. Mutually exclusive with `attribute_sub_field`,
550
+ * `date_offset`, and `attribute_operation`. When absent or length === 1,
551
+ * the legacy `attribute` field is used.
552
+ *
553
+ */
554
+ attributes?: [
555
+ string?,
556
+ string?,
557
+ string?,
558
+ string?,
559
+ string?,
560
+ string?,
561
+ string?,
562
+ string?,
563
+ string?,
564
+ string?
565
+ ];
566
+ /**
567
+ * Inner connector across `attributes`. `any` (default) means at least
568
+ * one attribute must satisfy the operator; `all` means every attribute
569
+ * must satisfy it. Ignored when `attributes` is absent or has length < 2.
570
+ *
571
+ */
572
+ attributes_match?: "any" | "all";
488
573
  /**
489
574
  * For complex attribute types, specifies which sub-field to extract (e.g., "address", "name", "email_type")
490
575
  */
@@ -503,10 +588,63 @@ declare namespace Components {
503
588
  unit?: "days" | "months" | "years";
504
589
  };
505
590
  }
591
+ /**
592
+ * A 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 — only structural errors do. The flow remains fully usable; users are encouraged to bring values within the limits.
593
+ */
594
+ export interface FlowLimitWarning {
595
+ /**
596
+ * i18n key identifying the exceeded limit (e.g. errors.task_max_incoming_edges).
597
+ */
598
+ i18nKey: string;
599
+ /**
600
+ * Human-readable description of the exceeded limit.
601
+ */
602
+ message: string;
603
+ /**
604
+ * The configured maximum for this limit.
605
+ */
606
+ max: number;
607
+ /**
608
+ * The actual value the flow currently has for this limit (e.g. the actual number of incoming connections).
609
+ */
610
+ current?: number;
611
+ /**
612
+ * ID of the task/node the limit applies to, when applicable.
613
+ */
614
+ node_id?: string;
615
+ task_name?: string;
616
+ branch_name?: string;
617
+ /**
618
+ * Name of the AI-agent parameter the limit applies to, when applicable.
619
+ */
620
+ param_name?: string;
621
+ /**
622
+ * JSON path within the flow to the offending value.
623
+ */
624
+ path: any[];
625
+ }
626
+ /**
627
+ * Base schema for V2 flow templates. A flow template defines the structure of a workflow
628
+ * including phases, tasks, edges, triggers, and other configuration. Flow templates serve
629
+ * as blueprints that can be instantiated as flow executions.
630
+ *
631
+ */
506
632
  export interface FlowTemplate {
633
+ /**
634
+ * Unique identifier for the flow template, generated by the system.
635
+ */
507
636
  id?: string;
637
+ /**
638
+ * Organization identifier that owns this flow template.
639
+ */
508
640
  org_id?: string;
641
+ /**
642
+ * Display name for the workflow, shown to users in the UI.
643
+ */
509
644
  name: string;
645
+ /**
646
+ * Optional detailed description of the workflow's purpose and behavior.
647
+ */
510
648
  description?: string;
511
649
  trigger?: /**
512
650
  * example:
@@ -597,11 +735,37 @@ declare namespace Components {
597
735
  * The manifest IDs associated with this workflow
598
736
  */
599
737
  _manifest?: string[];
738
+ /**
739
+ * When true, this is a linear flow: task enablement is computed at runtime from the graph — a task is enabled only when all of its direct predecessor tasks in its branch are done. This fully overrides any explicit per-task requirements.
740
+ */
741
+ linear?: boolean;
742
+ /**
743
+ * Non-blocking warnings for configuration limits the flow exceeds. Returned on read (get-flow) and on create/update responses. Size/count limits are soft: a flow exceeding them is still accepted and stored, and the violations are reported here so the UI can surface an informational banner. The flow is still fully editable and usable.
744
+ */
745
+ limit_warnings?: /* A 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 — only structural errors do. The flow remains fully usable; users are encouraged to bring values within the limits. */ FlowLimitWarning[];
600
746
  }
747
+ /**
748
+ * Base schema for V2 flow templates. A flow template defines the structure of a workflow
749
+ * including phases, tasks, edges, triggers, and other configuration. Flow templates serve
750
+ * as blueprints that can be instantiated as flow executions.
751
+ *
752
+ */
601
753
  export interface FlowTemplateBase {
754
+ /**
755
+ * Unique identifier for the flow template, generated by the system.
756
+ */
602
757
  id?: string;
758
+ /**
759
+ * Organization identifier that owns this flow template.
760
+ */
603
761
  org_id?: string;
762
+ /**
763
+ * Display name for the workflow, shown to users in the UI.
764
+ */
604
765
  name: string;
766
+ /**
767
+ * Optional detailed description of the workflow's purpose and behavior.
768
+ */
605
769
  description?: string;
606
770
  trigger?: /**
607
771
  * example:
@@ -692,6 +856,14 @@ declare namespace Components {
692
856
  * The manifest IDs associated with this workflow
693
857
  */
694
858
  _manifest?: string[];
859
+ /**
860
+ * When true, this is a linear flow: task enablement is computed at runtime from the graph — a task is enabled only when all of its direct predecessor tasks in its branch are done. This fully overrides any explicit per-task requirements.
861
+ */
862
+ linear?: boolean;
863
+ /**
864
+ * Non-blocking warnings for configuration limits the flow exceeds. Returned on read (get-flow) and on create/update responses. Size/count limits are soft: a flow exceeding them is still accepted and stored, and the violations are reported here so the UI can surface an informational banner. The flow is still fully editable and usable.
865
+ */
866
+ limit_warnings?: /* A 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 — only structural errors do. The flow remains fully usable; users are encouraged to bring values within the limits. */ FlowLimitWarning[];
695
867
  }
696
868
  /**
697
869
  * Short unique id (length 8) to identify the Flow Template.
@@ -700,7 +872,13 @@ declare namespace Components {
700
872
  */
701
873
  export type FlowTemplateId = string;
702
874
  export interface FlowTemplatesList {
703
- results: FlowTemplate[];
875
+ results: /**
876
+ * Base schema for V2 flow templates. A flow template defines the structure of a workflow
877
+ * including phases, tasks, edges, triggers, and other configuration. Flow templates serve
878
+ * as blueprints that can be instantiated as flow executions.
879
+ *
880
+ */
881
+ FlowTemplate[];
704
882
  }
705
883
  export interface ImmediateSchedule {
706
884
  mode?: "immediate";
@@ -830,7 +1008,14 @@ declare namespace Components {
830
1008
  * 2021-04-27T12:00:00.000Z
831
1009
  */
832
1010
  dueDate?: string;
833
- dynamicDueDate?: /* set a Duedate for a step then a specific */ DynamicDueDate;
1011
+ dynamicDueDate?: /**
1012
+ * Configuration for calculating a due date dynamically based on workflow events.
1013
+ * The due date is computed by adding a duration (numberOfUnits + timePeriod) to
1014
+ * a reference point defined by actionTypeCondition (e.g., when workflow started,
1015
+ * when a step closed, or when a phase finished).
1016
+ *
1017
+ */
1018
+ DynamicDueDate;
834
1019
  assignedTo?: string[];
835
1020
  steps: /* Action that needs to be done in a Workflow */ Step[];
836
1021
  /**
@@ -869,7 +1054,14 @@ declare namespace Components {
869
1054
  * 2021-04-27T12:00:00.000Z
870
1055
  */
871
1056
  dueDate?: string;
872
- dynamicDueDate?: /* set a Duedate for a step then a specific */ DynamicDueDate;
1057
+ dynamicDueDate?: /**
1058
+ * Configuration for calculating a due date dynamically based on workflow events.
1059
+ * The due date is computed by adding a duration (numberOfUnits + timePeriod) to
1060
+ * a reference point defined by actionTypeCondition (e.g., when workflow started,
1061
+ * when a step closed, or when a phase finished).
1062
+ *
1063
+ */
1064
+ DynamicDueDate;
873
1065
  /**
874
1066
  * This field is deprecated. Please use assignedTo
875
1067
  */
@@ -947,7 +1139,7 @@ declare namespace Components {
947
1139
  task_type: TaskType;
948
1140
  }
949
1141
  export type TaskType = "MANUAL" | "AUTOMATION" | "DECISION" | "AI_AGENT";
950
- export type TimeUnit = "minutes" | "hours" | "days" | "weeks" | "months";
1142
+ export type TimeUnit = "minutes" | "hours" | "days" | "weeks" | "months" | "years";
951
1143
  /**
952
1144
  * example:
953
1145
  * {
@@ -1010,9 +1202,25 @@ declare namespace Components {
1010
1202
  * 2
1011
1203
  */
1012
1204
  export type Version = "v1" | "v2" | "v3";
1205
+ /**
1206
+ * V1 workflow definition schema. Defines a linear workflow structure with sections
1207
+ * and steps. Sections group related steps together, and steps represent individual
1208
+ * tasks that need to be completed. This is the legacy workflow model; for new
1209
+ * implementations, consider using V2 flow templates instead.
1210
+ *
1211
+ */
1013
1212
  export interface WorkflowDefinition {
1213
+ /**
1214
+ * Unique identifier for the workflow definition, generated by the system.
1215
+ */
1014
1216
  id?: string;
1217
+ /**
1218
+ * Display name for the workflow, shown to users in the UI.
1219
+ */
1015
1220
  name: string;
1221
+ /**
1222
+ * Optional detailed description of the workflow's purpose and behavior.
1223
+ */
1016
1224
  description?: string;
1017
1225
  /**
1018
1226
  * ISO String Date & Time
@@ -1035,7 +1243,14 @@ declare namespace Components {
1035
1243
  * 2021-04-27T12:00:00.000Z
1036
1244
  */
1037
1245
  dueDate?: string;
1038
- dynamicDueDate?: /* set a Duedate for a step then a specific */ DynamicDueDate;
1246
+ dynamicDueDate?: /**
1247
+ * Configuration for calculating a due date dynamically based on workflow events.
1248
+ * The due date is computed by adding a duration (numberOfUnits + timePeriod) to
1249
+ * a reference point defined by actionTypeCondition (e.g., when workflow started,
1250
+ * when a step closed, or when a phase finished).
1251
+ *
1252
+ */
1253
+ DynamicDueDate;
1039
1254
  /**
1040
1255
  * This field is deprecated. Please use assignedTo
1041
1256
  */
@@ -1075,8 +1290,8 @@ declare namespace Paths {
1075
1290
  namespace Responses {
1076
1291
  export interface $202 {
1077
1292
  }
1078
- export type $400 = Components.Schemas.ErrorResp;
1079
- export type $500 = Components.Schemas.ErrorResp;
1293
+ export type $400 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
1294
+ export type $500 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
1080
1295
  }
1081
1296
  }
1082
1297
  namespace CreateClosingReason {
@@ -1086,21 +1301,53 @@ declare namespace Paths {
1086
1301
  }
1087
1302
  }
1088
1303
  namespace CreateDefinition {
1089
- export type RequestBody = Components.Schemas.WorkflowDefinition;
1304
+ export type RequestBody = /**
1305
+ * V1 workflow definition schema. Defines a linear workflow structure with sections
1306
+ * and steps. Sections group related steps together, and steps represent individual
1307
+ * tasks that need to be completed. This is the legacy workflow model; for new
1308
+ * implementations, consider using V2 flow templates instead.
1309
+ *
1310
+ */
1311
+ Components.Schemas.WorkflowDefinition;
1090
1312
  namespace Responses {
1091
- export type $201 = Components.Schemas.WorkflowDefinition;
1092
- export type $400 = Components.Schemas.ErrorResp;
1093
- export type $401 = Components.Schemas.ErrorResp;
1094
- export type $500 = Components.Schemas.ErrorResp;
1313
+ export type $201 = /**
1314
+ * V1 workflow definition schema. Defines a linear workflow structure with sections
1315
+ * and steps. Sections group related steps together, and steps represent individual
1316
+ * tasks that need to be completed. This is the legacy workflow model; for new
1317
+ * implementations, consider using V2 flow templates instead.
1318
+ *
1319
+ */
1320
+ Components.Schemas.WorkflowDefinition;
1321
+ export type $400 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
1322
+ export type $401 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
1323
+ export type $500 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
1095
1324
  }
1096
1325
  }
1097
1326
  namespace CreateFlowTemplate {
1098
- export type RequestBody = Components.Schemas.CreateFlowTemplate;
1327
+ namespace Parameters {
1328
+ export type EnforceLimits = boolean;
1329
+ }
1330
+ export interface QueryParameters {
1331
+ enforce_limits?: Parameters.EnforceLimits;
1332
+ }
1333
+ export type RequestBody = /**
1334
+ * Base schema for V2 flow templates. A flow template defines the structure of a workflow
1335
+ * including phases, tasks, edges, triggers, and other configuration. Flow templates serve
1336
+ * as blueprints that can be instantiated as flow executions.
1337
+ *
1338
+ */
1339
+ Components.Schemas.CreateFlowTemplate;
1099
1340
  namespace Responses {
1100
- export type $201 = Components.Schemas.FlowTemplate;
1101
- export type $400 = Components.Schemas.ErrorResp;
1102
- export type $401 = Components.Schemas.ErrorResp;
1103
- export type $500 = Components.Schemas.ErrorResp;
1341
+ export type $201 = /**
1342
+ * Base schema for V2 flow templates. A flow template defines the structure of a workflow
1343
+ * including phases, tasks, edges, triggers, and other configuration. Flow templates serve
1344
+ * as blueprints that can be instantiated as flow executions.
1345
+ *
1346
+ */
1347
+ Components.Schemas.FlowTemplate;
1348
+ export type $400 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
1349
+ export type $401 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
1350
+ export type $500 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
1104
1351
  }
1105
1352
  }
1106
1353
  namespace DeleteClosingReason {
@@ -1121,8 +1368,8 @@ declare namespace Paths {
1121
1368
  namespace Responses {
1122
1369
  export interface $204 {
1123
1370
  }
1124
- export type $403 = Components.Schemas.ErrorResp;
1125
- export type $404 = /* Closing reason could be not found */ Components.Schemas.ClosingReasonNotFoundResp;
1371
+ export type $403 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
1372
+ export type $404 = /* Error response returned when a closing reason is not found. */ Components.Schemas.ClosingReasonNotFoundResp;
1126
1373
  }
1127
1374
  }
1128
1375
  namespace DeleteDefinition {
@@ -1135,7 +1382,7 @@ declare namespace Paths {
1135
1382
  namespace Responses {
1136
1383
  export interface $204 {
1137
1384
  }
1138
- export type $401 = Components.Schemas.ErrorResp;
1385
+ export type $401 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
1139
1386
  export interface $404 {
1140
1387
  }
1141
1388
  }
@@ -1155,9 +1402,9 @@ declare namespace Paths {
1155
1402
  namespace Responses {
1156
1403
  export interface $204 {
1157
1404
  }
1158
- export type $401 = Components.Schemas.ErrorResp;
1159
- export interface $404 {
1160
- }
1405
+ export type $401 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
1406
+ export type $404 = /* Error response returned when a workflow definition or flow template is not found. */ Components.Schemas.DefinitionNotFoundResp;
1407
+ export type $500 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
1161
1408
  }
1162
1409
  }
1163
1410
  namespace DuplicateFlowTemplate {
@@ -1173,10 +1420,17 @@ declare namespace Paths {
1173
1420
  flowId: Parameters.FlowId;
1174
1421
  }
1175
1422
  namespace Responses {
1176
- export type $201 = Components.Schemas.FlowTemplate;
1177
- export type $400 = Components.Schemas.ErrorResp;
1178
- export type $401 = Components.Schemas.ErrorResp;
1179
- export type $500 = Components.Schemas.ErrorResp;
1423
+ export type $201 = /**
1424
+ * Base schema for V2 flow templates. A flow template defines the structure of a workflow
1425
+ * including phases, tasks, edges, triggers, and other configuration. Flow templates serve
1426
+ * as blueprints that can be instantiated as flow executions.
1427
+ *
1428
+ */
1429
+ Components.Schemas.FlowTemplate;
1430
+ export type $400 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
1431
+ export type $401 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
1432
+ export type $404 = /* Error response returned when a workflow definition or flow template is not found. */ Components.Schemas.DefinitionNotFoundResp;
1433
+ export type $500 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
1180
1434
  }
1181
1435
  }
1182
1436
  namespace GetAllClosingReasons {
@@ -1207,9 +1461,9 @@ declare namespace Paths {
1207
1461
  }
1208
1462
  namespace Responses {
1209
1463
  export type $200 = /* One Closing reason for a workflow */ Components.Schemas.ClosingReason;
1210
- export type $400 = Components.Schemas.ErrorResp;
1211
- export type $403 = Components.Schemas.ErrorResp;
1212
- export type $404 = /* Closing reason could be not found */ Components.Schemas.ClosingReasonNotFoundResp;
1464
+ export type $400 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
1465
+ export type $403 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
1466
+ export type $404 = /* Error response returned when a closing reason is not found. */ Components.Schemas.ClosingReasonNotFoundResp;
1213
1467
  }
1214
1468
  }
1215
1469
  namespace GetClosingReasonV1 {
@@ -1221,10 +1475,10 @@ declare namespace Paths {
1221
1475
  }
1222
1476
  namespace Responses {
1223
1477
  export type $200 = /* One Closing reason for a workflow */ Components.Schemas.ClosingReason;
1224
- export type $400 = Components.Schemas.ErrorResp;
1225
- export type $401 = Components.Schemas.ErrorResp;
1226
- export type $404 = /* Closing reason could be not found */ Components.Schemas.ClosingReasonNotFoundResp;
1227
- export type $500 = Components.Schemas.ErrorResp;
1478
+ export type $400 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
1479
+ export type $401 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
1480
+ export type $404 = /* Error response returned when a closing reason is not found. */ Components.Schemas.ClosingReasonNotFoundResp;
1481
+ export type $500 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
1228
1482
  }
1229
1483
  }
1230
1484
  namespace GetDefinition {
@@ -1235,17 +1489,31 @@ declare namespace Paths {
1235
1489
  definitionId: Parameters.DefinitionId;
1236
1490
  }
1237
1491
  namespace Responses {
1238
- export type $200 = Components.Schemas.WorkflowDefinition;
1239
- export type $400 = Components.Schemas.ErrorResp;
1240
- export type $401 = Components.Schemas.ErrorResp;
1241
- export type $404 = /* Definition could be not found */ Components.Schemas.DefinitionNotFoundResp;
1242
- export type $500 = Components.Schemas.ErrorResp;
1492
+ export type $200 = /**
1493
+ * V1 workflow definition schema. Defines a linear workflow structure with sections
1494
+ * and steps. Sections group related steps together, and steps represent individual
1495
+ * tasks that need to be completed. This is the legacy workflow model; for new
1496
+ * implementations, consider using V2 flow templates instead.
1497
+ *
1498
+ */
1499
+ Components.Schemas.WorkflowDefinition;
1500
+ export type $400 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
1501
+ export type $401 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
1502
+ export type $404 = /* Error response returned when a workflow definition or flow template is not found. */ Components.Schemas.DefinitionNotFoundResp;
1503
+ export type $500 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
1243
1504
  }
1244
1505
  }
1245
1506
  namespace GetDefinitions {
1246
1507
  namespace Responses {
1247
- export type $200 = Components.Schemas.WorkflowDefinition[];
1248
- export type $500 = Components.Schemas.ErrorResp;
1508
+ export type $200 = /**
1509
+ * V1 workflow definition schema. Defines a linear workflow structure with sections
1510
+ * and steps. Sections group related steps together, and steps represent individual
1511
+ * tasks that need to be completed. This is the legacy workflow model; for new
1512
+ * implementations, consider using V2 flow templates instead.
1513
+ *
1514
+ */
1515
+ Components.Schemas.WorkflowDefinition[];
1516
+ export type $500 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
1249
1517
  }
1250
1518
  }
1251
1519
  namespace GetFlowTemplate {
@@ -1261,17 +1529,23 @@ declare namespace Paths {
1261
1529
  flowId: Parameters.FlowId;
1262
1530
  }
1263
1531
  namespace Responses {
1264
- export type $200 = Components.Schemas.FlowTemplate;
1265
- export type $400 = Components.Schemas.ErrorResp;
1266
- export type $401 = Components.Schemas.ErrorResp;
1267
- export type $404 = /* Definition could be not found */ Components.Schemas.DefinitionNotFoundResp;
1268
- export type $500 = Components.Schemas.ErrorResp;
1532
+ export type $200 = /**
1533
+ * Base schema for V2 flow templates. A flow template defines the structure of a workflow
1534
+ * including phases, tasks, edges, triggers, and other configuration. Flow templates serve
1535
+ * as blueprints that can be instantiated as flow executions.
1536
+ *
1537
+ */
1538
+ Components.Schemas.FlowTemplate;
1539
+ export type $400 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
1540
+ export type $401 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
1541
+ export type $404 = /* Error response returned when a workflow definition or flow template is not found. */ Components.Schemas.DefinitionNotFoundResp;
1542
+ export type $500 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
1269
1543
  }
1270
1544
  }
1271
1545
  namespace GetMaxAllowedLimit {
1272
1546
  namespace Responses {
1273
1547
  export type $200 = Components.Schemas.MaxAllowedLimit;
1274
- export type $500 = Components.Schemas.ErrorResp;
1548
+ export type $500 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
1275
1549
  }
1276
1550
  }
1277
1551
  namespace GetWorkflowClosingReasons {
@@ -1298,7 +1572,7 @@ declare namespace Paths {
1298
1572
  }
1299
1573
  namespace Responses {
1300
1574
  export type $200 = Components.Schemas.FlowTemplatesList;
1301
- export type $500 = Components.Schemas.ErrorResp;
1575
+ export type $500 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
1302
1576
  }
1303
1577
  }
1304
1578
  namespace SearchFlowTemplates {
@@ -1306,9 +1580,15 @@ declare namespace Paths {
1306
1580
  namespace Responses {
1307
1581
  export interface $200 {
1308
1582
  hits?: number;
1309
- results?: Components.Schemas.FlowTemplate[];
1583
+ results?: /**
1584
+ * Base schema for V2 flow templates. A flow template defines the structure of a workflow
1585
+ * including phases, tasks, edges, triggers, and other configuration. Flow templates serve
1586
+ * as blueprints that can be instantiated as flow executions.
1587
+ *
1588
+ */
1589
+ Components.Schemas.FlowTemplate[];
1310
1590
  }
1311
- export type $500 = Components.Schemas.ErrorResp;
1591
+ export type $500 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
1312
1592
  }
1313
1593
  }
1314
1594
  namespace SetWorkflowClosingReasons {
@@ -1342,9 +1622,9 @@ declare namespace Paths {
1342
1622
  export type RequestBody = /* One Closing reason for a workflow */ Components.Schemas.ClosingReason;
1343
1623
  namespace Responses {
1344
1624
  export type $200 = /* One Closing reason for a workflow */ Components.Schemas.ClosingReason;
1345
- export type $400 = Components.Schemas.ErrorResp;
1346
- export type $403 = Components.Schemas.ErrorResp;
1347
- export type $404 = /* Closing reason could be not found */ Components.Schemas.ClosingReasonNotFoundResp;
1625
+ export type $400 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
1626
+ export type $403 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
1627
+ export type $404 = /* Error response returned when a closing reason is not found. */ Components.Schemas.ClosingReasonNotFoundResp;
1348
1628
  }
1349
1629
  }
1350
1630
  namespace UpdateDefinition {
@@ -1354,16 +1634,31 @@ declare namespace Paths {
1354
1634
  export interface PathParameters {
1355
1635
  definitionId: Parameters.DefinitionId;
1356
1636
  }
1357
- export type RequestBody = Components.Schemas.WorkflowDefinition;
1637
+ export type RequestBody = /**
1638
+ * V1 workflow definition schema. Defines a linear workflow structure with sections
1639
+ * and steps. Sections group related steps together, and steps represent individual
1640
+ * tasks that need to be completed. This is the legacy workflow model; for new
1641
+ * implementations, consider using V2 flow templates instead.
1642
+ *
1643
+ */
1644
+ Components.Schemas.WorkflowDefinition;
1358
1645
  namespace Responses {
1359
- export type $200 = Components.Schemas.WorkflowDefinition;
1360
- export type $400 = Components.Schemas.ErrorResp;
1361
- export type $401 = Components.Schemas.ErrorResp;
1362
- export type $500 = Components.Schemas.ErrorResp;
1646
+ export type $200 = /**
1647
+ * V1 workflow definition schema. Defines a linear workflow structure with sections
1648
+ * and steps. Sections group related steps together, and steps represent individual
1649
+ * tasks that need to be completed. This is the legacy workflow model; for new
1650
+ * implementations, consider using V2 flow templates instead.
1651
+ *
1652
+ */
1653
+ Components.Schemas.WorkflowDefinition;
1654
+ export type $400 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
1655
+ export type $401 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
1656
+ export type $500 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
1363
1657
  }
1364
1658
  }
1365
1659
  namespace UpdateFlowTemplate {
1366
1660
  namespace Parameters {
1661
+ export type EnforceLimits = boolean;
1367
1662
  export type FlowId = /**
1368
1663
  * Short unique id (length 8) to identify the Flow Template.
1369
1664
  * example:
@@ -1374,13 +1669,29 @@ declare namespace Paths {
1374
1669
  export interface PathParameters {
1375
1670
  flowId: Parameters.FlowId;
1376
1671
  }
1377
- export type RequestBody = Components.Schemas.FlowTemplate;
1672
+ export interface QueryParameters {
1673
+ enforce_limits?: Parameters.EnforceLimits;
1674
+ }
1675
+ export type RequestBody = /**
1676
+ * Base schema for V2 flow templates. A flow template defines the structure of a workflow
1677
+ * including phases, tasks, edges, triggers, and other configuration. Flow templates serve
1678
+ * as blueprints that can be instantiated as flow executions.
1679
+ *
1680
+ */
1681
+ Components.Schemas.FlowTemplate;
1378
1682
  namespace Responses {
1379
- export type $200 = Components.Schemas.FlowTemplate;
1380
- export type $400 = Components.Schemas.ErrorResp;
1381
- export type $401 = Components.Schemas.ErrorResp;
1382
- export type $409 = Components.Schemas.ErrorResp;
1383
- export type $500 = Components.Schemas.ErrorResp;
1683
+ export type $200 = /**
1684
+ * Base schema for V2 flow templates. A flow template defines the structure of a workflow
1685
+ * including phases, tasks, edges, triggers, and other configuration. Flow templates serve
1686
+ * as blueprints that can be instantiated as flow executions.
1687
+ *
1688
+ */
1689
+ Components.Schemas.FlowTemplate;
1690
+ export type $400 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
1691
+ export type $401 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
1692
+ export type $404 = /* Error response returned when a workflow definition or flow template is not found. */ Components.Schemas.DefinitionNotFoundResp;
1693
+ export type $409 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
1694
+ export type $500 = /* Standard error response returned when an API request fails. */ Components.Schemas.ErrorResp;
1384
1695
  }
1385
1696
  }
1386
1697
  }
@@ -1400,7 +1711,7 @@ interface OperationMethods {
1400
1711
  /**
1401
1712
  * getDefinitions - getDefinitions
1402
1713
  *
1403
- * Retrieve all Workflow Definitions from an Organization
1714
+ * Retrieve all V1 workflow definitions belonging to the authenticated organization.
1404
1715
  */
1405
1716
  'getDefinitions'(
1406
1717
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -1410,7 +1721,10 @@ interface OperationMethods {
1410
1721
  /**
1411
1722
  * createDefinition - createDefinition
1412
1723
  *
1413
- * Create a Workflow Definition.
1724
+ * Create a new V1 workflow definition. The definition consists of sections and steps
1725
+ * that define the structure of the workflow. Once created, the definition can be used
1726
+ * to start workflow executions.
1727
+ *
1414
1728
  */
1415
1729
  'createDefinition'(
1416
1730
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -1430,10 +1744,15 @@ interface OperationMethods {
1430
1744
  /**
1431
1745
  * createFlowTemplate - createFlowTemplate
1432
1746
  *
1433
- * Create a new Flow Template.
1747
+ * Create a new Flow Template (V2 workflow definition).
1748
+ *
1749
+ * A flow template defines the structure of a workflow including its phases, tasks,
1750
+ * edges (connections between tasks), and trigger configuration. Once created, the
1751
+ * template can be used to start workflow executions.
1752
+ *
1434
1753
  */
1435
1754
  'createFlowTemplate'(
1436
- parameters?: Parameters<UnknownParamsObject> | null,
1755
+ parameters?: Parameters<Paths.CreateFlowTemplate.QueryParameters> | null,
1437
1756
  data?: Paths.CreateFlowTemplate.RequestBody,
1438
1757
  config?: AxiosRequestConfig
1439
1758
  ): OperationResponse<Paths.CreateFlowTemplate.Responses.$201>
@@ -1450,7 +1769,7 @@ interface OperationMethods {
1450
1769
  /**
1451
1770
  * getFlowTemplate - getFlowTemplate
1452
1771
  *
1453
- * Get specific FLow template for a customer
1772
+ * Retrieve a specific flow template by its unique identifier.
1454
1773
  */
1455
1774
  'getFlowTemplate'(
1456
1775
  parameters?: Parameters<Paths.GetFlowTemplate.PathParameters> | null,
@@ -1463,7 +1782,7 @@ interface OperationMethods {
1463
1782
  * Update Flow Template.
1464
1783
  */
1465
1784
  'updateFlowTemplate'(
1466
- parameters?: Parameters<Paths.UpdateFlowTemplate.PathParameters> | null,
1785
+ parameters?: Parameters<Paths.UpdateFlowTemplate.QueryParameters & Paths.UpdateFlowTemplate.PathParameters> | null,
1467
1786
  data?: Paths.UpdateFlowTemplate.RequestBody,
1468
1787
  config?: AxiosRequestConfig
1469
1788
  ): OperationResponse<Paths.UpdateFlowTemplate.Responses.$200>
@@ -1480,7 +1799,10 @@ interface OperationMethods {
1480
1799
  /**
1481
1800
  * duplicateFlowTemplate - duplicateFlowTemplate
1482
1801
  *
1483
- * Duplicate a Flow Template from an existing workflow.
1802
+ * Create a copy of an existing flow template. The duplicated template will have a new
1803
+ * unique identifier and can be modified independently of the original. This is useful
1804
+ * for creating variations of existing workflows without starting from scratch.
1805
+ *
1484
1806
  */
1485
1807
  'duplicateFlowTemplate'(
1486
1808
  parameters?: Parameters<Paths.DuplicateFlowTemplate.PathParameters> | null,
@@ -1626,7 +1948,7 @@ interface PathsDictionary {
1626
1948
  /**
1627
1949
  * getDefinitions - getDefinitions
1628
1950
  *
1629
- * Retrieve all Workflow Definitions from an Organization
1951
+ * Retrieve all V1 workflow definitions belonging to the authenticated organization.
1630
1952
  */
1631
1953
  'get'(
1632
1954
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -1636,7 +1958,10 @@ interface PathsDictionary {
1636
1958
  /**
1637
1959
  * createDefinition - createDefinition
1638
1960
  *
1639
- * Create a Workflow Definition.
1961
+ * Create a new V1 workflow definition. The definition consists of sections and steps
1962
+ * that define the structure of the workflow. Once created, the definition can be used
1963
+ * to start workflow executions.
1964
+ *
1640
1965
  */
1641
1966
  'post'(
1642
1967
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -1658,10 +1983,15 @@ interface PathsDictionary {
1658
1983
  /**
1659
1984
  * createFlowTemplate - createFlowTemplate
1660
1985
  *
1661
- * Create a new Flow Template.
1986
+ * Create a new Flow Template (V2 workflow definition).
1987
+ *
1988
+ * A flow template defines the structure of a workflow including its phases, tasks,
1989
+ * edges (connections between tasks), and trigger configuration. Once created, the
1990
+ * template can be used to start workflow executions.
1991
+ *
1662
1992
  */
1663
1993
  'post'(
1664
- parameters?: Parameters<UnknownParamsObject> | null,
1994
+ parameters?: Parameters<Paths.CreateFlowTemplate.QueryParameters> | null,
1665
1995
  data?: Paths.CreateFlowTemplate.RequestBody,
1666
1996
  config?: AxiosRequestConfig
1667
1997
  ): OperationResponse<Paths.CreateFlowTemplate.Responses.$201>
@@ -1682,7 +2012,7 @@ interface PathsDictionary {
1682
2012
  /**
1683
2013
  * getFlowTemplate - getFlowTemplate
1684
2014
  *
1685
- * Get specific FLow template for a customer
2015
+ * Retrieve a specific flow template by its unique identifier.
1686
2016
  */
1687
2017
  'get'(
1688
2018
  parameters?: Parameters<Paths.GetFlowTemplate.PathParameters> | null,
@@ -1695,7 +2025,7 @@ interface PathsDictionary {
1695
2025
  * Update Flow Template.
1696
2026
  */
1697
2027
  'put'(
1698
- parameters?: Parameters<Paths.UpdateFlowTemplate.PathParameters> | null,
2028
+ parameters?: Parameters<Paths.UpdateFlowTemplate.QueryParameters & Paths.UpdateFlowTemplate.PathParameters> | null,
1699
2029
  data?: Paths.UpdateFlowTemplate.RequestBody,
1700
2030
  config?: AxiosRequestConfig
1701
2031
  ): OperationResponse<Paths.UpdateFlowTemplate.Responses.$200>
@@ -1714,7 +2044,10 @@ interface PathsDictionary {
1714
2044
  /**
1715
2045
  * duplicateFlowTemplate - duplicateFlowTemplate
1716
2046
  *
1717
- * Duplicate a Flow Template from an existing workflow.
2047
+ * Create a copy of an existing flow template. The duplicated template will have a new
2048
+ * unique identifier and can be modified independently of the original. This is useful
2049
+ * for creating variations of existing workflows without starting from scratch.
2050
+ *
1718
2051
  */
1719
2052
  'post'(
1720
2053
  parameters?: Parameters<Paths.DuplicateFlowTemplate.PathParameters> | null,
@@ -1884,6 +2217,7 @@ type EnableRequirement = Components.Schemas.EnableRequirement;
1884
2217
  type EntitySync = Components.Schemas.EntitySync;
1885
2218
  type ErrorResp = Components.Schemas.ErrorResp;
1886
2219
  type EvaluationSource = Components.Schemas.EvaluationSource;
2220
+ type FlowLimitWarning = Components.Schemas.FlowLimitWarning;
1887
2221
  type FlowTemplate = Components.Schemas.FlowTemplate;
1888
2222
  type FlowTemplateBase = Components.Schemas.FlowTemplateBase;
1889
2223
  type FlowTemplateId = Components.Schemas.FlowTemplateId;
@@ -1919,4 +2253,4 @@ type VariableAssignment = Components.Schemas.VariableAssignment;
1919
2253
  type Version = Components.Schemas.Version;
1920
2254
  type WorkflowDefinition = Components.Schemas.WorkflowDefinition;
1921
2255
 
1922
- export { type StepRequirement as $, type ActionSchedule as A, type FlowTemplateBase as B, type Client as C, type DecisionTask as D, type ECPDetails as E, type FlowTemplate as F, type FlowTemplateId as G, type FlowTemplatesList as H, type ImmediateSchedule as I, type ItemType as J, type JourneyAutomationTrigger as K, type JourneySubmissionTrigger as L, type ManualTask as M, type ManualTrigger as N, type OperationMethods as O, Paths as P, type MaxAllowedLimit as Q, type Operator as R, type PartnerDetails as S, type Phase as T, type RelativeSchedule as U, SearchFlowTemplates as V, type Section as W, type Statement as X, type Step as Y, type StepDescription as Z, type StepJourney as _, Components as a, type StepType as a0, type Task as a1, type TaskBase as a2, type TaskType as a3, type TimeUnit as a4, type Trigger as a5, type TriggerMode as a6, type TriggerType as a7, type UpdateEntityAttributes as a8, type VariableAssignment as a9, type Version as aa, type WorkflowDefinition as ab, type PathsDictionary as b, type AgentConfig as c, type AiAgentTask as d, type AutomationConfig as e, type AutomationInputContext as f, type AutomationTask as g, type AutomationTrigger as h, type ChangeReasonStatusReq as i, type ClosingReason as j, type ClosingReasonId as k, type ClosingReasonNotFoundResp as l, type ClosingReasons as m, type ClosingReasonsIds as n, type ClosingReasonsStatus as o, type Condition as p, CreateFlowTemplate as q, type DefinitionNotFoundResp as r, type DelayedSchedule as s, type DueDateConfig as t, type DynamicDueDate as u, type Edge as v, type EnableRequirement as w, type EntitySync as x, type ErrorResp as y, type EvaluationSource as z };
2256
+ export { type StepJourney as $, type ActionSchedule as A, type FlowTemplate as B, type Client as C, type DecisionTask as D, type ECPDetails as E, type FlowLimitWarning as F, type FlowTemplateBase as G, type FlowTemplateId as H, type FlowTemplatesList as I, type ImmediateSchedule as J, type ItemType as K, type JourneyAutomationTrigger as L, type JourneySubmissionTrigger as M, type ManualTask as N, type OperationMethods as O, Paths as P, type ManualTrigger as Q, type MaxAllowedLimit as R, type Operator as S, type PartnerDetails as T, type Phase as U, type RelativeSchedule as V, SearchFlowTemplates as W, type Section as X, type Statement as Y, type Step as Z, type StepDescription as _, Components as a, type StepRequirement as a0, type StepType as a1, type Task as a2, type TaskBase as a3, type TaskType as a4, type TimeUnit as a5, type Trigger as a6, type TriggerMode as a7, type TriggerType as a8, type UpdateEntityAttributes as a9, type VariableAssignment as aa, type Version as ab, type WorkflowDefinition as ac, type PathsDictionary as b, type AgentConfig as c, type AiAgentTask as d, type AutomationConfig as e, type AutomationInputContext as f, type AutomationTask as g, type AutomationTrigger as h, type ChangeReasonStatusReq as i, type ClosingReason as j, type ClosingReasonId as k, type ClosingReasonNotFoundResp as l, type ClosingReasons as m, type ClosingReasonsIds as n, type ClosingReasonsStatus as o, type Condition as p, CreateFlowTemplate as q, type DefinitionNotFoundResp as r, type DelayedSchedule as s, type DueDateConfig as t, type DynamicDueDate as u, type Edge as v, type EnableRequirement as w, type EntitySync as x, type ErrorResp as y, type EvaluationSource as z };