@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.
- package/definitions/customer-portal-runtime.json +1 -1
- package/definitions/customer-portal.json +164 -16
- package/definitions/focus-pocus-runtime.json +1 -0
- package/definitions/focus-pocus.json +757 -0
- package/definitions/user-runtime.json +1 -1
- package/definitions/user.json +146 -0
- package/definitions/workflow-definition-runtime.json +1 -1
- package/definitions/workflow-definition.json +281 -47
- package/definitions/workflow.json +12 -0
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/calendar.cjs +6 -6
- package/dist/apis/calendar.js +1 -1
- package/dist/apis/configuration-hub.cjs +6 -6
- package/dist/apis/configuration-hub.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +8 -8
- package/dist/apis/customer-portal.d.cts +2 -2
- package/dist/apis/customer-portal.d.ts +2 -2
- package/dist/apis/customer-portal.js +2 -2
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-governance.cjs +6 -6
- package/dist/apis/data-governance.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/integration-toolkit.cjs +6 -6
- package/dist/apis/integration-toolkit.js +1 -1
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +6 -6
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/snapshot.cjs +6 -6
- package/dist/apis/snapshot.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +8 -8
- package/dist/apis/user.d.cts +2 -2
- package/dist/apis/user.d.ts +2 -2
- package/dist/apis/user.js +2 -2
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +8 -8
- package/dist/apis/workflow-definition.d.cts +2 -2
- package/dist/apis/workflow-definition.d.ts +2 -2
- package/dist/apis/workflow-definition.js +2 -2
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.d.cts +2 -2
- package/dist/apis/workflow.d.ts +2 -2
- package/dist/apis/workflow.js +1 -1
- package/dist/chunk-6HJ2Y7DZ.js +14 -0
- package/dist/chunk-BFMY2X2J.cjs +14 -0
- package/dist/{chunk-AJDY36Y6.cjs → chunk-C35OPQHY.cjs} +7 -7
- package/dist/{chunk-NFIYEMMM.js → chunk-N254AABZ.js} +1 -1
- package/dist/chunk-OSPTVXY4.js +14 -0
- package/dist/chunk-QNSMYDKG.cjs +14 -0
- package/dist/{chunk-L3UZLJPQ.js → chunk-SQQJND25.js} +7 -7
- package/dist/{chunk-OWXEZ56F.cjs → chunk-X2LMHC5R.cjs} +1 -1
- package/dist/customer-portal-6I3G44I4.cjs +7 -0
- package/dist/customer-portal-PTVGKDUH.js +7 -0
- package/dist/{customer-portal-runtime-VRGCSOVU.cjs → customer-portal-runtime-4ACQGDNY.cjs} +2 -2
- package/dist/{customer-portal-runtime-NRIQG6IO.js → customer-portal-runtime-E4RI7NYM.js} +1 -1
- package/dist/{customer-portal.d-fWVl8_mE.d.cts → customer-portal.d-Bpc-wk9K.d.cts} +140 -12
- package/dist/{customer-portal.d-fWVl8_mE.d.ts → customer-portal.d-Bpc-wk9K.d.ts} +140 -12
- package/dist/index.cjs +14 -14
- package/dist/index.d.cts +4 -4
- package/dist/index.d.ts +4 -4
- package/dist/index.js +4 -4
- package/dist/js-yaml-DLCVPJ7G.js +0 -0
- package/dist/user-5KLWGPQ2.js +7 -0
- package/dist/user-GZLPNGIW.cjs +7 -0
- package/dist/user-runtime-6TSL4RZN.cjs +5 -0
- package/dist/{user-runtime-6ICV2Y73.js → user-runtime-UPFER72E.js} +1 -1
- package/dist/{user.d-L-C7_K84.d.cts → user.d-6bp0zEwE.d.cts} +131 -0
- package/dist/{user.d-L-C7_K84.d.ts → user.d-6bp0zEwE.d.ts} +131 -0
- package/dist/workflow-JQT3F5NJ.cjs +7 -0
- package/dist/workflow-Q6FAE5OL.js +7 -0
- package/dist/workflow-definition-5P3PDJKU.cjs +7 -0
- package/dist/workflow-definition-XSSOSEGF.js +7 -0
- package/dist/{workflow-definition-runtime-GACBV4WM.cjs → workflow-definition-runtime-2HQS3RPK.cjs} +2 -2
- package/dist/{workflow-definition-runtime-OVXRSE34.js → workflow-definition-runtime-JUPATIKU.js} +1 -1
- package/dist/{workflow-definition.d-DOeb0KVV.d.cts → workflow-definition.d-CweGhhBU.d.cts} +416 -82
- package/dist/{workflow-definition.d-DOeb0KVV.d.ts → workflow-definition.d-CweGhhBU.d.ts} +416 -82
- package/dist/{workflow.d-eFv0ecBi.d.cts → workflow.d-5cyNJgVQ.d.cts} +28 -0
- package/dist/{workflow.d-eFv0ecBi.d.ts → workflow.d-5cyNJgVQ.d.ts} +28 -0
- package/docs/customer-portal.md +86 -21
- package/docs/user.md +174 -11
- package/docs/workflow-definition.md +179 -43
- package/docs/workflow.md +16 -7
- package/package.json +12 -11
- package/dist/chunk-43GJY2EB.js +0 -14
- package/dist/chunk-4H2KIKGL.cjs +0 -14
- package/dist/chunk-COASF7ZR.js +0 -14
- package/dist/chunk-CYS6QBW6.cjs +0 -14
- package/dist/customer-portal-F45XWLIO.cjs +0 -7
- package/dist/customer-portal-MYNJZ4OW.js +0 -7
- package/dist/user-3SLAEEVD.cjs +0 -7
- package/dist/user-PRUYBXQV.js +0 -7
- package/dist/user-runtime-Y3227ETX.cjs +0 -5
- package/dist/workflow-7OU2YEEI.cjs +0 -7
- package/dist/workflow-IVKCWS44.js +0 -7
- package/dist/workflow-definition-2VF7S23G.js +0 -7
- package/dist/workflow-definition-U6YXD42W.cjs +0 -7
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
# Workflows Definitions
|
|
2
2
|
|
|
3
|
-
- **Base URL:** `https://workflows-definition.sls.epilot.io`
|
|
4
3
|
- **Full API Docs:** [https://docs.epilot.io/api/workflow-definition](https://docs.epilot.io/api/workflow-definition)
|
|
5
4
|
|
|
6
5
|
## Usage
|
|
@@ -53,6 +52,7 @@ const { data } = await workflowDefinitionClient.getMaxAllowedLimit(...)
|
|
|
53
52
|
|
|
54
53
|
**Schemas**
|
|
55
54
|
- [`FlowTemplateBase`](#flowtemplatebase)
|
|
55
|
+
- [`FlowLimitWarning`](#flowlimitwarning)
|
|
56
56
|
- [`FlowTemplate`](#flowtemplate)
|
|
57
57
|
- [`Version`](#version)
|
|
58
58
|
- [`Trigger`](#trigger)
|
|
@@ -140,7 +140,7 @@ const { data } = await client.getMaxAllowedLimit()
|
|
|
140
140
|
|
|
141
141
|
### `getDefinitions`
|
|
142
142
|
|
|
143
|
-
Retrieve all
|
|
143
|
+
Retrieve all V1 workflow definitions belonging to the authenticated organization.
|
|
144
144
|
|
|
145
145
|
`GET /v1/workflows/definitions`
|
|
146
146
|
|
|
@@ -194,7 +194,9 @@ const { data } = await client.getDefinitions()
|
|
|
194
194
|
|
|
195
195
|
### `createDefinition`
|
|
196
196
|
|
|
197
|
-
Create a
|
|
197
|
+
Create a new V1 workflow definition. The definition consists of sections and steps
|
|
198
|
+
that define the structure of the workflow. Once created, the definition can be used
|
|
199
|
+
to start workflow executions.
|
|
198
200
|
|
|
199
201
|
`POST /v1/workflows/definitions`
|
|
200
202
|
|
|
@@ -386,7 +388,9 @@ const { data } = await client.listFlowTemplates({
|
|
|
386
388
|
"entity_sync": [],
|
|
387
389
|
"taxonomies": ["string"],
|
|
388
390
|
"singleClosingReasonSelection": true,
|
|
389
|
-
"_manifest": ["string"]
|
|
391
|
+
"_manifest": ["string"],
|
|
392
|
+
"linear": true,
|
|
393
|
+
"limit_warnings": []
|
|
390
394
|
}
|
|
391
395
|
]
|
|
392
396
|
}
|
|
@@ -398,13 +402,15 @@ const { data } = await client.listFlowTemplates({
|
|
|
398
402
|
|
|
399
403
|
### `createFlowTemplate`
|
|
400
404
|
|
|
401
|
-
Create a new Flow Template.
|
|
405
|
+
Create a new Flow Template (V2 workflow definition).
|
|
402
406
|
|
|
403
407
|
`POST /v2/flows/templates`
|
|
404
408
|
|
|
405
409
|
```ts
|
|
406
410
|
const { data } = await client.createFlowTemplate(
|
|
407
|
-
|
|
411
|
+
{
|
|
412
|
+
enforce_limits: true,
|
|
413
|
+
},
|
|
408
414
|
{
|
|
409
415
|
id: 'string',
|
|
410
416
|
org_id: 'string',
|
|
@@ -519,7 +525,21 @@ const { data } = await client.createFlowTemplate(
|
|
|
519
525
|
],
|
|
520
526
|
taxonomies: ['string'],
|
|
521
527
|
singleClosingReasonSelection: true,
|
|
522
|
-
_manifest: ['string']
|
|
528
|
+
_manifest: ['string'],
|
|
529
|
+
linear: true,
|
|
530
|
+
limit_warnings: [
|
|
531
|
+
{
|
|
532
|
+
i18nKey: 'string',
|
|
533
|
+
message: 'string',
|
|
534
|
+
max: 0,
|
|
535
|
+
current: 0,
|
|
536
|
+
node_id: 'string',
|
|
537
|
+
task_name: 'string',
|
|
538
|
+
branch_name: 'string',
|
|
539
|
+
param_name: 'string',
|
|
540
|
+
path: [ /* ... */ ]
|
|
541
|
+
}
|
|
542
|
+
]
|
|
523
543
|
},
|
|
524
544
|
)
|
|
525
545
|
```
|
|
@@ -640,7 +660,21 @@ const { data } = await client.createFlowTemplate(
|
|
|
640
660
|
],
|
|
641
661
|
"taxonomies": ["string"],
|
|
642
662
|
"singleClosingReasonSelection": true,
|
|
643
|
-
"_manifest": ["string"]
|
|
663
|
+
"_manifest": ["string"],
|
|
664
|
+
"linear": true,
|
|
665
|
+
"limit_warnings": [
|
|
666
|
+
{
|
|
667
|
+
"i18nKey": "string",
|
|
668
|
+
"message": "string",
|
|
669
|
+
"max": 0,
|
|
670
|
+
"current": 0,
|
|
671
|
+
"node_id": "string",
|
|
672
|
+
"task_name": "string",
|
|
673
|
+
"branch_name": "string",
|
|
674
|
+
"param_name": "string",
|
|
675
|
+
"path": []
|
|
676
|
+
}
|
|
677
|
+
]
|
|
644
678
|
}
|
|
645
679
|
```
|
|
646
680
|
|
|
@@ -699,7 +733,9 @@ const { data } = await client.searchFlowTemplates(
|
|
|
699
733
|
"entity_sync": [],
|
|
700
734
|
"taxonomies": ["string"],
|
|
701
735
|
"singleClosingReasonSelection": true,
|
|
702
|
-
"_manifest": ["string"]
|
|
736
|
+
"_manifest": ["string"],
|
|
737
|
+
"linear": true,
|
|
738
|
+
"limit_warnings": []
|
|
703
739
|
}
|
|
704
740
|
]
|
|
705
741
|
}
|
|
@@ -711,7 +747,7 @@ const { data } = await client.searchFlowTemplates(
|
|
|
711
747
|
|
|
712
748
|
### `getFlowTemplate`
|
|
713
749
|
|
|
714
|
-
|
|
750
|
+
Retrieve a specific flow template by its unique identifier.
|
|
715
751
|
|
|
716
752
|
`GET /v2/flows/templates/{flowId}`
|
|
717
753
|
|
|
@@ -837,7 +873,21 @@ const { data } = await client.getFlowTemplate({
|
|
|
837
873
|
],
|
|
838
874
|
"taxonomies": ["string"],
|
|
839
875
|
"singleClosingReasonSelection": true,
|
|
840
|
-
"_manifest": ["string"]
|
|
876
|
+
"_manifest": ["string"],
|
|
877
|
+
"linear": true,
|
|
878
|
+
"limit_warnings": [
|
|
879
|
+
{
|
|
880
|
+
"i18nKey": "string",
|
|
881
|
+
"message": "string",
|
|
882
|
+
"max": 0,
|
|
883
|
+
"current": 0,
|
|
884
|
+
"node_id": "string",
|
|
885
|
+
"task_name": "string",
|
|
886
|
+
"branch_name": "string",
|
|
887
|
+
"param_name": "string",
|
|
888
|
+
"path": []
|
|
889
|
+
}
|
|
890
|
+
]
|
|
841
891
|
}
|
|
842
892
|
```
|
|
843
893
|
|
|
@@ -855,6 +905,7 @@ Update Flow Template.
|
|
|
855
905
|
const { data } = await client.updateFlowTemplate(
|
|
856
906
|
{
|
|
857
907
|
flowId: 'example',
|
|
908
|
+
enforce_limits: true,
|
|
858
909
|
},
|
|
859
910
|
{
|
|
860
911
|
id: 'string',
|
|
@@ -970,7 +1021,21 @@ const { data } = await client.updateFlowTemplate(
|
|
|
970
1021
|
],
|
|
971
1022
|
taxonomies: ['string'],
|
|
972
1023
|
singleClosingReasonSelection: true,
|
|
973
|
-
_manifest: ['string']
|
|
1024
|
+
_manifest: ['string'],
|
|
1025
|
+
linear: true,
|
|
1026
|
+
limit_warnings: [
|
|
1027
|
+
{
|
|
1028
|
+
i18nKey: 'string',
|
|
1029
|
+
message: 'string',
|
|
1030
|
+
max: 0,
|
|
1031
|
+
current: 0,
|
|
1032
|
+
node_id: 'string',
|
|
1033
|
+
task_name: 'string',
|
|
1034
|
+
branch_name: 'string',
|
|
1035
|
+
param_name: 'string',
|
|
1036
|
+
path: [ /* ... */ ]
|
|
1037
|
+
}
|
|
1038
|
+
]
|
|
974
1039
|
},
|
|
975
1040
|
)
|
|
976
1041
|
```
|
|
@@ -1091,7 +1156,21 @@ const { data } = await client.updateFlowTemplate(
|
|
|
1091
1156
|
],
|
|
1092
1157
|
"taxonomies": ["string"],
|
|
1093
1158
|
"singleClosingReasonSelection": true,
|
|
1094
|
-
"_manifest": ["string"]
|
|
1159
|
+
"_manifest": ["string"],
|
|
1160
|
+
"linear": true,
|
|
1161
|
+
"limit_warnings": [
|
|
1162
|
+
{
|
|
1163
|
+
"i18nKey": "string",
|
|
1164
|
+
"message": "string",
|
|
1165
|
+
"max": 0,
|
|
1166
|
+
"current": 0,
|
|
1167
|
+
"node_id": "string",
|
|
1168
|
+
"task_name": "string",
|
|
1169
|
+
"branch_name": "string",
|
|
1170
|
+
"param_name": "string",
|
|
1171
|
+
"path": []
|
|
1172
|
+
}
|
|
1173
|
+
]
|
|
1095
1174
|
}
|
|
1096
1175
|
```
|
|
1097
1176
|
|
|
@@ -1115,7 +1194,9 @@ const { data } = await client.deleteFlowTemplate({
|
|
|
1115
1194
|
|
|
1116
1195
|
### `duplicateFlowTemplate`
|
|
1117
1196
|
|
|
1118
|
-
|
|
1197
|
+
Create a copy of an existing flow template. The duplicated template will have a new
|
|
1198
|
+
unique identifier and can be modified independently of the original. This is useful
|
|
1199
|
+
for creating variations of exist
|
|
1119
1200
|
|
|
1120
1201
|
`POST /v2/flows/templates/{flowId}/duplicate`
|
|
1121
1202
|
|
|
@@ -1241,7 +1322,21 @@ const { data } = await client.duplicateFlowTemplate({
|
|
|
1241
1322
|
],
|
|
1242
1323
|
"taxonomies": ["string"],
|
|
1243
1324
|
"singleClosingReasonSelection": true,
|
|
1244
|
-
"_manifest": ["string"]
|
|
1325
|
+
"_manifest": ["string"],
|
|
1326
|
+
"linear": true,
|
|
1327
|
+
"limit_warnings": [
|
|
1328
|
+
{
|
|
1329
|
+
"i18nKey": "string",
|
|
1330
|
+
"message": "string",
|
|
1331
|
+
"max": 0,
|
|
1332
|
+
"current": 0,
|
|
1333
|
+
"node_id": "string",
|
|
1334
|
+
"task_name": "string",
|
|
1335
|
+
"branch_name": "string",
|
|
1336
|
+
"param_name": "string",
|
|
1337
|
+
"path": []
|
|
1338
|
+
}
|
|
1339
|
+
]
|
|
1245
1340
|
}
|
|
1246
1341
|
```
|
|
1247
1342
|
|
|
@@ -1729,6 +1824,11 @@ const { data } = await client.setWorkflowClosingReasons(
|
|
|
1729
1824
|
|
|
1730
1825
|
### `FlowTemplateBase`
|
|
1731
1826
|
|
|
1827
|
+
Base schema for V2 flow templates. A flow template defines the structure of a workflow
|
|
1828
|
+
including phases, tasks, edges, triggers, and other configuration. Flow templates serve
|
|
1829
|
+
as blueprints that can be instantiated as flow executions.
|
|
1830
|
+
|
|
1831
|
+
|
|
1732
1832
|
```ts
|
|
1733
1833
|
type FlowTemplateBase = {
|
|
1734
1834
|
id?: string
|
|
@@ -1766,7 +1866,7 @@ type FlowTemplateBase = {
|
|
|
1766
1866
|
due_date?: string
|
|
1767
1867
|
due_date_config?: {
|
|
1768
1868
|
duration: number
|
|
1769
|
-
unit: "minutes" | "hours" | "days" | "weeks" | "months"
|
|
1869
|
+
unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
|
|
1770
1870
|
type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"
|
|
1771
1871
|
task_id?: string
|
|
1772
1872
|
phase_id?: string
|
|
@@ -1834,6 +1934,24 @@ type FlowTemplateBase = {
|
|
|
1834
1934
|
}
|
|
1835
1935
|
```
|
|
1836
1936
|
|
|
1937
|
+
### `FlowLimitWarning`
|
|
1938
|
+
|
|
1939
|
+
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 va
|
|
1940
|
+
|
|
1941
|
+
```ts
|
|
1942
|
+
type FlowLimitWarning = {
|
|
1943
|
+
i18nKey: string
|
|
1944
|
+
message: string
|
|
1945
|
+
max: number
|
|
1946
|
+
current?: number
|
|
1947
|
+
node_id?: string
|
|
1948
|
+
task_name?: string
|
|
1949
|
+
branch_name?: string
|
|
1950
|
+
param_name?: string
|
|
1951
|
+
path: unknown[]
|
|
1952
|
+
}
|
|
1953
|
+
```
|
|
1954
|
+
|
|
1837
1955
|
### `FlowTemplate`
|
|
1838
1956
|
|
|
1839
1957
|
```ts
|
|
@@ -1873,7 +1991,7 @@ type FlowTemplate = {
|
|
|
1873
1991
|
due_date?: string
|
|
1874
1992
|
due_date_config?: {
|
|
1875
1993
|
duration: number
|
|
1876
|
-
unit: "minutes" | "hours" | "days" | "weeks" | "months"
|
|
1994
|
+
unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
|
|
1877
1995
|
type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"
|
|
1878
1996
|
task_id?: string
|
|
1879
1997
|
phase_id?: string
|
|
@@ -2068,7 +2186,7 @@ type CreateFlowTemplate = {
|
|
|
2068
2186
|
due_date?: string
|
|
2069
2187
|
due_date_config?: {
|
|
2070
2188
|
duration: number
|
|
2071
|
-
unit: "minutes" | "hours" | "days" | "weeks" | "months"
|
|
2189
|
+
unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
|
|
2072
2190
|
type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"
|
|
2073
2191
|
task_id?: string
|
|
2074
2192
|
phase_id?: string
|
|
@@ -2285,7 +2403,7 @@ type Task = {
|
|
|
2285
2403
|
due_date?: string
|
|
2286
2404
|
due_date_config?: {
|
|
2287
2405
|
duration: number
|
|
2288
|
-
unit: "minutes" | "hours" | "days" | "weeks" | "months"
|
|
2406
|
+
unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
|
|
2289
2407
|
type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"
|
|
2290
2408
|
task_id?: string
|
|
2291
2409
|
phase_id?: string
|
|
@@ -2345,7 +2463,7 @@ type Task = {
|
|
|
2345
2463
|
due_date?: string
|
|
2346
2464
|
due_date_config?: {
|
|
2347
2465
|
duration: number
|
|
2348
|
-
unit: "minutes" | "hours" | "days" | "weeks" | "months"
|
|
2466
|
+
unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
|
|
2349
2467
|
type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"
|
|
2350
2468
|
task_id?: string
|
|
2351
2469
|
phase_id?: string
|
|
@@ -2392,7 +2510,7 @@ type ManualTask = {
|
|
|
2392
2510
|
due_date?: string
|
|
2393
2511
|
due_date_config?: {
|
|
2394
2512
|
duration: number
|
|
2395
|
-
unit: "minutes" | "hours" | "days" | "weeks" | "months"
|
|
2513
|
+
unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
|
|
2396
2514
|
type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"
|
|
2397
2515
|
task_id?: string
|
|
2398
2516
|
phase_id?: string
|
|
@@ -2458,7 +2576,7 @@ type AutomationTask = {
|
|
|
2458
2576
|
due_date?: string
|
|
2459
2577
|
due_date_config?: {
|
|
2460
2578
|
duration: number
|
|
2461
|
-
unit: "minutes" | "hours" | "days" | "weeks" | "months"
|
|
2579
|
+
unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
|
|
2462
2580
|
type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"
|
|
2463
2581
|
task_id?: string
|
|
2464
2582
|
phase_id?: string
|
|
@@ -2520,12 +2638,12 @@ type AutomationTask = {
|
|
|
2520
2638
|
} | {
|
|
2521
2639
|
mode: "delayed"
|
|
2522
2640
|
duration: number
|
|
2523
|
-
unit: "minutes" | "hours" | "days" | "weeks" | "months"
|
|
2641
|
+
unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
|
|
2524
2642
|
} | {
|
|
2525
2643
|
mode: "relative"
|
|
2526
2644
|
direction: "before" | "after"
|
|
2527
2645
|
duration: number
|
|
2528
|
-
unit: "minutes" | "hours" | "days" | "weeks" | "months"
|
|
2646
|
+
unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
|
|
2529
2647
|
reference: {
|
|
2530
2648
|
id: { ... }
|
|
2531
2649
|
origin: { ... }
|
|
@@ -2587,7 +2705,7 @@ type AiAgentTask = {
|
|
|
2587
2705
|
due_date?: string
|
|
2588
2706
|
due_date_config?: {
|
|
2589
2707
|
duration: number
|
|
2590
|
-
unit: "minutes" | "hours" | "days" | "weeks" | "months"
|
|
2708
|
+
unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
|
|
2591
2709
|
type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"
|
|
2592
2710
|
task_id?: string
|
|
2593
2711
|
phase_id?: string
|
|
@@ -2661,12 +2779,12 @@ type ActionSchedule = {
|
|
|
2661
2779
|
} | {
|
|
2662
2780
|
mode: "delayed"
|
|
2663
2781
|
duration: number
|
|
2664
|
-
unit: "minutes" | "hours" | "days" | "weeks" | "months"
|
|
2782
|
+
unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
|
|
2665
2783
|
} | {
|
|
2666
2784
|
mode: "relative"
|
|
2667
2785
|
direction: "before" | "after"
|
|
2668
2786
|
duration: number
|
|
2669
|
-
unit: "minutes" | "hours" | "days" | "weeks" | "months"
|
|
2787
|
+
unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
|
|
2670
2788
|
reference: {
|
|
2671
2789
|
id: string
|
|
2672
2790
|
origin: "flow_started" | "task_completed" | "trigger_entity_attribute" | "all_preceding_tasks_completed"
|
|
@@ -2690,7 +2808,7 @@ type ImmediateSchedule = {
|
|
|
2690
2808
|
type DelayedSchedule = {
|
|
2691
2809
|
mode: "delayed"
|
|
2692
2810
|
duration: number
|
|
2693
|
-
unit: "minutes" | "hours" | "days" | "weeks" | "months"
|
|
2811
|
+
unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
|
|
2694
2812
|
}
|
|
2695
2813
|
```
|
|
2696
2814
|
|
|
@@ -2701,7 +2819,7 @@ type RelativeSchedule = {
|
|
|
2701
2819
|
mode: "relative"
|
|
2702
2820
|
direction: "before" | "after"
|
|
2703
2821
|
duration: number
|
|
2704
|
-
unit: "minutes" | "hours" | "days" | "weeks" | "months"
|
|
2822
|
+
unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
|
|
2705
2823
|
reference: {
|
|
2706
2824
|
id: string
|
|
2707
2825
|
origin: "flow_started" | "task_completed" | "trigger_entity_attribute" | "all_preceding_tasks_completed"
|
|
@@ -2730,7 +2848,7 @@ type DecisionTask = {
|
|
|
2730
2848
|
due_date?: string
|
|
2731
2849
|
due_date_config?: {
|
|
2732
2850
|
duration: number
|
|
2733
|
-
unit: "minutes" | "hours" | "days" | "weeks" | "months"
|
|
2851
|
+
unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
|
|
2734
2852
|
type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"
|
|
2735
2853
|
task_id?: string
|
|
2736
2854
|
phase_id?: string
|
|
@@ -2791,12 +2909,12 @@ type DecisionTask = {
|
|
|
2791
2909
|
schedule?: {
|
|
2792
2910
|
mode: "delayed"
|
|
2793
2911
|
duration: number
|
|
2794
|
-
unit: "minutes" | "hours" | "days" | "weeks" | "months"
|
|
2912
|
+
unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
|
|
2795
2913
|
} | {
|
|
2796
2914
|
mode: "relative"
|
|
2797
2915
|
direction: "before" | "after"
|
|
2798
2916
|
duration: number
|
|
2799
|
-
unit: "minutes" | "hours" | "days" | "weeks" | "months"
|
|
2917
|
+
unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
|
|
2800
2918
|
reference: {
|
|
2801
2919
|
id: { ... }
|
|
2802
2920
|
origin: { ... }
|
|
@@ -2831,7 +2949,7 @@ type TaskBase = {
|
|
|
2831
2949
|
due_date?: string
|
|
2832
2950
|
due_date_config?: {
|
|
2833
2951
|
duration: number
|
|
2834
|
-
unit: "minutes" | "hours" | "days" | "weeks" | "months"
|
|
2952
|
+
unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
|
|
2835
2953
|
type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"
|
|
2836
2954
|
task_id?: string
|
|
2837
2955
|
phase_id?: string
|
|
@@ -2887,7 +3005,7 @@ type Phase = {
|
|
|
2887
3005
|
due_date?: string
|
|
2888
3006
|
due_date_config?: {
|
|
2889
3007
|
duration: number
|
|
2890
|
-
unit: "minutes" | "hours" | "days" | "weeks" | "months"
|
|
3008
|
+
unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
|
|
2891
3009
|
type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"
|
|
2892
3010
|
task_id?: string
|
|
2893
3011
|
phase_id?: string
|
|
@@ -2947,6 +3065,8 @@ type Condition = {
|
|
|
2947
3065
|
attribute_type?: { ... }
|
|
2948
3066
|
attribute_repeatable?: { ... }
|
|
2949
3067
|
attribute_operation?: { ... }
|
|
3068
|
+
attributes?: { ... }
|
|
3069
|
+
attributes_match?: { ... }
|
|
2950
3070
|
attribute_sub_field?: { ... }
|
|
2951
3071
|
date_offset?: { ... }
|
|
2952
3072
|
}
|
|
@@ -2971,6 +3091,8 @@ type Statement = {
|
|
|
2971
3091
|
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"
|
|
2972
3092
|
attribute_repeatable?: boolean
|
|
2973
3093
|
attribute_operation?: "all" | "updated" | "added" | "deleted"
|
|
3094
|
+
attributes?: string[]
|
|
3095
|
+
attributes_match?: "any" | "all"
|
|
2974
3096
|
attribute_sub_field?: string
|
|
2975
3097
|
date_offset?: {
|
|
2976
3098
|
amount?: { ... }
|
|
@@ -2995,6 +3117,8 @@ type EvaluationSource = {
|
|
|
2995
3117
|
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"
|
|
2996
3118
|
attribute_repeatable?: boolean
|
|
2997
3119
|
attribute_operation?: "all" | "updated" | "added" | "deleted"
|
|
3120
|
+
attributes?: string[]
|
|
3121
|
+
attributes_match?: "any" | "all"
|
|
2998
3122
|
attribute_sub_field?: string
|
|
2999
3123
|
date_offset?: {
|
|
3000
3124
|
amount?: number
|
|
@@ -3016,7 +3140,7 @@ Set due date for the task based on a dynamic condition
|
|
|
3016
3140
|
```ts
|
|
3017
3141
|
type DueDateConfig = {
|
|
3018
3142
|
duration: number
|
|
3019
|
-
unit: "minutes" | "hours" | "days" | "weeks" | "months"
|
|
3143
|
+
unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
|
|
3020
3144
|
type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"
|
|
3021
3145
|
task_id?: string
|
|
3022
3146
|
phase_id?: string
|
|
@@ -3026,7 +3150,7 @@ type DueDateConfig = {
|
|
|
3026
3150
|
### `TimeUnit`
|
|
3027
3151
|
|
|
3028
3152
|
```ts
|
|
3029
|
-
type TimeUnit = "minutes" | "hours" | "days" | "weeks" | "months"
|
|
3153
|
+
type TimeUnit = "minutes" | "hours" | "days" | "weeks" | "months" | "years"
|
|
3030
3154
|
```
|
|
3031
3155
|
|
|
3032
3156
|
### `EnableRequirement`
|
|
@@ -3043,6 +3167,12 @@ type EnableRequirement = {
|
|
|
3043
3167
|
|
|
3044
3168
|
### `WorkflowDefinition`
|
|
3045
3169
|
|
|
3170
|
+
V1 workflow definition schema. Defines a linear workflow structure with sections
|
|
3171
|
+
and steps. Sections group related steps together, and steps represent individual
|
|
3172
|
+
tasks that need to be completed. This is the legacy workflow model; for new
|
|
3173
|
+
implementations, consider using V2 flow templates instead.
|
|
3174
|
+
|
|
3175
|
+
|
|
3046
3176
|
```ts
|
|
3047
3177
|
type WorkflowDefinition = {
|
|
3048
3178
|
id?: string
|
|
@@ -3054,7 +3184,7 @@ type WorkflowDefinition = {
|
|
|
3054
3184
|
dueDate?: string
|
|
3055
3185
|
dynamicDueDate?: {
|
|
3056
3186
|
numberOfUnits: number
|
|
3057
|
-
timePeriod: "minutes" | "hours" | "days" | "weeks" | "months"
|
|
3187
|
+
timePeriod: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
|
|
3058
3188
|
actionTypeCondition: "WORKFLOW_STARTED" | "STEP_CLOSED" | "PHASE_FINISHED"
|
|
3059
3189
|
stepId?: string
|
|
3060
3190
|
phaseId?: string
|
|
@@ -3174,7 +3304,7 @@ type Step = {
|
|
|
3174
3304
|
dueDate?: string
|
|
3175
3305
|
dynamicDueDate?: {
|
|
3176
3306
|
numberOfUnits: number
|
|
3177
|
-
timePeriod: "minutes" | "hours" | "days" | "weeks" | "months"
|
|
3307
|
+
timePeriod: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
|
|
3178
3308
|
actionTypeCondition: "WORKFLOW_STARTED" | "STEP_CLOSED" | "PHASE_FINISHED"
|
|
3179
3309
|
stepId?: string
|
|
3180
3310
|
phaseId?: string
|
|
@@ -3231,7 +3361,7 @@ type Section = {
|
|
|
3231
3361
|
dueDate?: string
|
|
3232
3362
|
dynamicDueDate?: {
|
|
3233
3363
|
numberOfUnits: number
|
|
3234
|
-
timePeriod: "minutes" | "hours" | "days" | "weeks" | "months"
|
|
3364
|
+
timePeriod: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
|
|
3235
3365
|
actionTypeCondition: "WORKFLOW_STARTED" | "STEP_CLOSED" | "PHASE_FINISHED"
|
|
3236
3366
|
stepId?: string
|
|
3237
3367
|
phaseId?: string
|
|
@@ -3375,7 +3505,7 @@ type MaxAllowedLimit = {
|
|
|
3375
3505
|
|
|
3376
3506
|
### `DefinitionNotFoundResp`
|
|
3377
3507
|
|
|
3378
|
-
|
|
3508
|
+
Error response returned when a workflow definition or flow template is not found.
|
|
3379
3509
|
|
|
3380
3510
|
```ts
|
|
3381
3511
|
type DefinitionNotFoundResp = {
|
|
@@ -3385,7 +3515,7 @@ type DefinitionNotFoundResp = {
|
|
|
3385
3515
|
|
|
3386
3516
|
### `ClosingReasonNotFoundResp`
|
|
3387
3517
|
|
|
3388
|
-
|
|
3518
|
+
Error response returned when a closing reason is not found.
|
|
3389
3519
|
|
|
3390
3520
|
```ts
|
|
3391
3521
|
type ClosingReasonNotFoundResp = {
|
|
@@ -3455,6 +3585,8 @@ type ClosingReasonId = {
|
|
|
3455
3585
|
|
|
3456
3586
|
### `ErrorResp`
|
|
3457
3587
|
|
|
3588
|
+
Standard error response returned when an API request fails.
|
|
3589
|
+
|
|
3458
3590
|
```ts
|
|
3459
3591
|
type ErrorResp = {
|
|
3460
3592
|
message?: string
|
|
@@ -3497,12 +3629,16 @@ type EntitySync = {
|
|
|
3497
3629
|
|
|
3498
3630
|
### `DynamicDueDate`
|
|
3499
3631
|
|
|
3500
|
-
|
|
3632
|
+
Configuration for calculating a due date dynamically based on workflow events.
|
|
3633
|
+
The due date is computed by adding a duration (numberOfUnits + timePeriod) to
|
|
3634
|
+
a reference point defined by actionTypeCondition (e.g., when workflow started,
|
|
3635
|
+
when a step closed, or when a phase finished).
|
|
3636
|
+
|
|
3501
3637
|
|
|
3502
3638
|
```ts
|
|
3503
3639
|
type DynamicDueDate = {
|
|
3504
3640
|
numberOfUnits: number
|
|
3505
|
-
timePeriod: "minutes" | "hours" | "days" | "weeks" | "months"
|
|
3641
|
+
timePeriod: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
|
|
3506
3642
|
actionTypeCondition: "WORKFLOW_STARTED" | "STEP_CLOSED" | "PHASE_FINISHED"
|
|
3507
3643
|
stepId?: string
|
|
3508
3644
|
phaseId?: string
|
package/docs/workflow.md
CHANGED
|
@@ -870,7 +870,8 @@ const { data } = await client.startFlowExecution(
|
|
|
870
870
|
"last_heal_attempted_at": "1970-01-01T00:00:00.000Z"
|
|
871
871
|
}
|
|
872
872
|
},
|
|
873
|
-
"singleClosingReasonSelection": true
|
|
873
|
+
"singleClosingReasonSelection": true,
|
|
874
|
+
"linear": true
|
|
874
875
|
}
|
|
875
876
|
```
|
|
876
877
|
|
|
@@ -1016,7 +1017,8 @@ const { data } = await client.getFlowExecution({
|
|
|
1016
1017
|
"last_heal_attempted_at": "1970-01-01T00:00:00.000Z"
|
|
1017
1018
|
}
|
|
1018
1019
|
},
|
|
1019
|
-
"singleClosingReasonSelection": true
|
|
1020
|
+
"singleClosingReasonSelection": true,
|
|
1021
|
+
"linear": true
|
|
1020
1022
|
}
|
|
1021
1023
|
```
|
|
1022
1024
|
|
|
@@ -1198,7 +1200,8 @@ const { data } = await client.patchFlowExecution(
|
|
|
1198
1200
|
"last_heal_attempted_at": "1970-01-01T00:00:00.000Z"
|
|
1199
1201
|
}
|
|
1200
1202
|
},
|
|
1201
|
-
"singleClosingReasonSelection": true
|
|
1203
|
+
"singleClosingReasonSelection": true,
|
|
1204
|
+
"linear": true
|
|
1202
1205
|
}
|
|
1203
1206
|
```
|
|
1204
1207
|
|
|
@@ -1266,7 +1269,8 @@ const { data } = await client.searchFlowExecutions(
|
|
|
1266
1269
|
"entity_sync": [],
|
|
1267
1270
|
"taxonomies": ["string"],
|
|
1268
1271
|
"trigger": {},
|
|
1269
|
-
"singleClosingReasonSelection": true
|
|
1272
|
+
"singleClosingReasonSelection": true,
|
|
1273
|
+
"linear": true
|
|
1270
1274
|
}
|
|
1271
1275
|
]
|
|
1272
1276
|
}
|
|
@@ -2023,7 +2027,8 @@ const { data } = await client.reconcileAutomationTask({
|
|
|
2023
2027
|
"last_heal_attempted_at": "1970-01-01T00:00:00.000Z"
|
|
2024
2028
|
}
|
|
2025
2029
|
},
|
|
2026
|
-
"singleClosingReasonSelection": true
|
|
2030
|
+
"singleClosingReasonSelection": true,
|
|
2031
|
+
"linear": true
|
|
2027
2032
|
}
|
|
2028
2033
|
```
|
|
2029
2034
|
|
|
@@ -4108,8 +4113,8 @@ type AutomationTask = {
|
|
|
4108
4113
|
unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
|
|
4109
4114
|
schedule_id?: string
|
|
4110
4115
|
scheduled_at?: string
|
|
4116
|
+
error_reason?: string
|
|
4111
4117
|
} | {
|
|
4112
|
-
mode: "relative"
|
|
4113
4118
|
// ...
|
|
4114
4119
|
}
|
|
4115
4120
|
```
|
|
@@ -4153,6 +4158,7 @@ type ActionSchedule = {
|
|
|
4153
4158
|
unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
|
|
4154
4159
|
schedule_id?: string
|
|
4155
4160
|
scheduled_at?: string
|
|
4161
|
+
error_reason?: string
|
|
4156
4162
|
} | {
|
|
4157
4163
|
mode: "relative"
|
|
4158
4164
|
direction: "before" | "after"
|
|
@@ -4166,6 +4172,7 @@ type ActionSchedule = {
|
|
|
4166
4172
|
}
|
|
4167
4173
|
schedule_id?: string
|
|
4168
4174
|
scheduled_at?: string
|
|
4175
|
+
error_reason?: string
|
|
4169
4176
|
}
|
|
4170
4177
|
```
|
|
4171
4178
|
|
|
@@ -4186,6 +4193,7 @@ type DelayedSchedule = {
|
|
|
4186
4193
|
unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
|
|
4187
4194
|
schedule_id?: string
|
|
4188
4195
|
scheduled_at?: string
|
|
4196
|
+
error_reason?: string
|
|
4189
4197
|
}
|
|
4190
4198
|
```
|
|
4191
4199
|
|
|
@@ -4205,6 +4213,7 @@ type RelativeSchedule = {
|
|
|
4205
4213
|
}
|
|
4206
4214
|
schedule_id?: string
|
|
4207
4215
|
scheduled_at?: string
|
|
4216
|
+
error_reason?: string
|
|
4208
4217
|
}
|
|
4209
4218
|
```
|
|
4210
4219
|
|
|
@@ -4309,8 +4318,8 @@ type DecisionTask = {
|
|
|
4309
4318
|
unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years"
|
|
4310
4319
|
schedule_id?: string
|
|
4311
4320
|
scheduled_at?: string
|
|
4321
|
+
error_reason?: string
|
|
4312
4322
|
} | {
|
|
4313
|
-
mode: "relative"
|
|
4314
4323
|
// ...
|
|
4315
4324
|
}
|
|
4316
4325
|
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@epilot/sdk",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.13.0",
|
|
4
4
|
"description": "JavaScript/TypeScript SDK for epilot APIs",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.cjs",
|
|
@@ -322,6 +322,16 @@
|
|
|
322
322
|
},
|
|
323
323
|
"./workflow-definition/openapi.json": "./definitions/workflow-definition.json"
|
|
324
324
|
},
|
|
325
|
+
"scripts": {
|
|
326
|
+
"generate": "tsx ../../scripts/generate-sdk-v2.ts && pnpm lint:fix",
|
|
327
|
+
"build": "tsup",
|
|
328
|
+
"build:watch": "tsup --watch",
|
|
329
|
+
"test": "vitest run",
|
|
330
|
+
"test:watch": "vitest",
|
|
331
|
+
"lint": "biome check src",
|
|
332
|
+
"lint:fix": "biome check src --fix",
|
|
333
|
+
"prepublishOnly": "npm run build"
|
|
334
|
+
},
|
|
325
335
|
"keywords": [
|
|
326
336
|
"epilot",
|
|
327
337
|
"sdk",
|
|
@@ -515,14 +525,5 @@
|
|
|
515
525
|
"./dist/apis/workflow-definition.d.ts"
|
|
516
526
|
]
|
|
517
527
|
}
|
|
518
|
-
},
|
|
519
|
-
"scripts": {
|
|
520
|
-
"generate": "tsx ../../scripts/generate-sdk-v2.ts && pnpm lint:fix",
|
|
521
|
-
"build": "tsup",
|
|
522
|
-
"build:watch": "tsup --watch",
|
|
523
|
-
"test": "vitest run",
|
|
524
|
-
"test:watch": "vitest",
|
|
525
|
-
"lint": "biome check src",
|
|
526
|
-
"lint:fix": "biome check src --fix"
|
|
527
528
|
}
|
|
528
|
-
}
|
|
529
|
+
}
|