@epilot/sdk 2.2.4 → 2.2.5
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/workflow-definition-runtime.json +1 -1
- package/definitions/workflow-definition.json +72 -201
- 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/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +6 -6
- package/dist/apis/customer-portal.js +1 -1
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-management.cjs +6 -6
- package/dist/apis/data-management.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/erp-integration.cjs +6 -6
- package/dist/apis/erp-integration.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/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/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.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 +6 -6
- package/dist/apis/user.js +1 -1
- 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.js +1 -1
- package/dist/chunk-43GJY2EB.js +14 -0
- package/dist/chunk-CYS6QBW6.cjs +14 -0
- package/dist/{chunk-I3TEIPPB.js → chunk-OTSGPLDM.js} +2 -2
- package/dist/{chunk-KLVWUQMJ.cjs → chunk-ZXLTSQYE.cjs} +2 -2
- package/dist/index.cjs +10 -10
- package/dist/index.d.cts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +2 -2
- package/dist/workflow-definition-MBOMPMCG.js +7 -0
- package/dist/workflow-definition-SPAHD3HS.cjs +7 -0
- package/dist/{workflow-definition-runtime-VRND6VQR.cjs → workflow-definition-runtime-GACBV4WM.cjs} +2 -2
- package/dist/{workflow-definition-runtime-S7AZHOU7.js → workflow-definition-runtime-OVXRSE34.js} +1 -1
- package/dist/{workflow-definition.d-CE3kk9gl.d.cts → workflow-definition.d-CtmE-ymB.d.cts} +52 -211
- package/dist/{workflow-definition.d-CE3kk9gl.d.ts → workflow-definition.d-CtmE-ymB.d.ts} +52 -211
- package/docs/workflow-definition.md +121 -487
- package/package.json +1 -1
- package/dist/chunk-46HU6232.cjs +0 -14
- package/dist/chunk-5JPM6YUD.js +0 -14
- package/dist/workflow-definition-B6ELOZUR.cjs +0 -7
- package/dist/workflow-definition-D24CRCK2.js +0 -7
|
@@ -42,8 +42,6 @@ const { data } = await workflowDefinitionClient.getMaxAllowedLimit(...)
|
|
|
42
42
|
- [`updateFlowTemplate`](#updateflowtemplate)
|
|
43
43
|
- [`deleteFlowTemplate`](#deleteflowtemplate)
|
|
44
44
|
- [`duplicateFlowTemplate`](#duplicateflowtemplate)
|
|
45
|
-
- [`exportFlowTemplate`](#exportflowtemplate)
|
|
46
|
-
- [`importFlowTemplate`](#importflowtemplate)
|
|
47
45
|
|
|
48
46
|
**Closing Reason**
|
|
49
47
|
- [`getAllClosingReasons`](#getallclosingreasons)
|
|
@@ -98,6 +96,7 @@ const { data } = await workflowDefinitionClient.getMaxAllowedLimit(...)
|
|
|
98
96
|
- [`StepType`](#steptype)
|
|
99
97
|
- [`StepJourney`](#stepjourney)
|
|
100
98
|
- [`ECPDetails`](#ecpdetails)
|
|
99
|
+
- [`PartnerDetails`](#partnerdetails)
|
|
101
100
|
- [`StepDescription`](#stepdescription)
|
|
102
101
|
- [`MaxAllowedLimit`](#maxallowedlimit)
|
|
103
102
|
- [`DefinitionNotFoundResp`](#definitionnotfoundresp)
|
|
@@ -113,8 +112,6 @@ const { data } = await workflowDefinitionClient.getMaxAllowedLimit(...)
|
|
|
113
112
|
- [`EntitySync`](#entitysync)
|
|
114
113
|
- [`DynamicDueDate`](#dynamicduedate)
|
|
115
114
|
- [`StepRequirement`](#steprequirement)
|
|
116
|
-
- [`FlowTemplateExport`](#flowtemplateexport)
|
|
117
|
-
- [`FlowTemplateImportResult`](#flowtemplateimportresult)
|
|
118
115
|
|
|
119
116
|
### `getMaxAllowedLimit`
|
|
120
117
|
|
|
@@ -248,6 +245,7 @@ const { data } = await client.createDefinition(
|
|
|
248
245
|
type: 'STEP',
|
|
249
246
|
ecp: { /* ... */ },
|
|
250
247
|
installer: { /* ... */ },
|
|
248
|
+
partner: { /* ... */ },
|
|
251
249
|
taxonomies: ['string']
|
|
252
250
|
}
|
|
253
251
|
],
|
|
@@ -318,6 +316,7 @@ const { data } = await client.createDefinition(
|
|
|
318
316
|
"type": "STEP",
|
|
319
317
|
"ecp": {},
|
|
320
318
|
"installer": {},
|
|
319
|
+
"partner": {},
|
|
321
320
|
"taxonomies": ["string"]
|
|
322
321
|
}
|
|
323
322
|
],
|
|
@@ -460,6 +459,7 @@ const { data } = await client.createFlowTemplate(
|
|
|
460
459
|
assigned_to: ['string'],
|
|
461
460
|
ecp: { /* ... */ },
|
|
462
461
|
installer: { /* ... */ },
|
|
462
|
+
partner: { /* ... */ },
|
|
463
463
|
taxonomies: ['string'],
|
|
464
464
|
phase_id: 'string',
|
|
465
465
|
task_type: 'MANUAL'
|
|
@@ -475,6 +475,7 @@ const { data } = await client.createFlowTemplate(
|
|
|
475
475
|
assigned_to: ['string'],
|
|
476
476
|
ecp: { /* ... */ },
|
|
477
477
|
installer: { /* ... */ },
|
|
478
|
+
partner: { /* ... */ },
|
|
478
479
|
taxonomies: ['string'],
|
|
479
480
|
phase_id: 'string',
|
|
480
481
|
task_type: 'MANUAL',
|
|
@@ -578,6 +579,7 @@ const { data } = await client.createFlowTemplate(
|
|
|
578
579
|
"assigned_to": ["string"],
|
|
579
580
|
"ecp": {},
|
|
580
581
|
"installer": {},
|
|
582
|
+
"partner": {},
|
|
581
583
|
"taxonomies": ["string"],
|
|
582
584
|
"phase_id": "string",
|
|
583
585
|
"task_type": "MANUAL"
|
|
@@ -593,6 +595,7 @@ const { data } = await client.createFlowTemplate(
|
|
|
593
595
|
"assigned_to": ["string"],
|
|
594
596
|
"ecp": {},
|
|
595
597
|
"installer": {},
|
|
598
|
+
"partner": {},
|
|
596
599
|
"taxonomies": ["string"],
|
|
597
600
|
"phase_id": "string",
|
|
598
601
|
"task_type": "MANUAL",
|
|
@@ -770,6 +773,7 @@ const { data } = await client.getFlowTemplate({
|
|
|
770
773
|
"assigned_to": ["string"],
|
|
771
774
|
"ecp": {},
|
|
772
775
|
"installer": {},
|
|
776
|
+
"partner": {},
|
|
773
777
|
"taxonomies": ["string"],
|
|
774
778
|
"phase_id": "string",
|
|
775
779
|
"task_type": "MANUAL"
|
|
@@ -785,6 +789,7 @@ const { data } = await client.getFlowTemplate({
|
|
|
785
789
|
"assigned_to": ["string"],
|
|
786
790
|
"ecp": {},
|
|
787
791
|
"installer": {},
|
|
792
|
+
"partner": {},
|
|
788
793
|
"taxonomies": ["string"],
|
|
789
794
|
"phase_id": "string",
|
|
790
795
|
"task_type": "MANUAL",
|
|
@@ -898,6 +903,7 @@ const { data } = await client.updateFlowTemplate(
|
|
|
898
903
|
assigned_to: ['string'],
|
|
899
904
|
ecp: { /* ... */ },
|
|
900
905
|
installer: { /* ... */ },
|
|
906
|
+
partner: { /* ... */ },
|
|
901
907
|
taxonomies: ['string'],
|
|
902
908
|
phase_id: 'string',
|
|
903
909
|
task_type: 'MANUAL'
|
|
@@ -913,6 +919,7 @@ const { data } = await client.updateFlowTemplate(
|
|
|
913
919
|
assigned_to: ['string'],
|
|
914
920
|
ecp: { /* ... */ },
|
|
915
921
|
installer: { /* ... */ },
|
|
922
|
+
partner: { /* ... */ },
|
|
916
923
|
taxonomies: ['string'],
|
|
917
924
|
phase_id: 'string',
|
|
918
925
|
task_type: 'MANUAL',
|
|
@@ -1016,6 +1023,7 @@ const { data } = await client.updateFlowTemplate(
|
|
|
1016
1023
|
"assigned_to": ["string"],
|
|
1017
1024
|
"ecp": {},
|
|
1018
1025
|
"installer": {},
|
|
1026
|
+
"partner": {},
|
|
1019
1027
|
"taxonomies": ["string"],
|
|
1020
1028
|
"phase_id": "string",
|
|
1021
1029
|
"task_type": "MANUAL"
|
|
@@ -1031,6 +1039,7 @@ const { data } = await client.updateFlowTemplate(
|
|
|
1031
1039
|
"assigned_to": ["string"],
|
|
1032
1040
|
"ecp": {},
|
|
1033
1041
|
"installer": {},
|
|
1042
|
+
"partner": {},
|
|
1034
1043
|
"taxonomies": ["string"],
|
|
1035
1044
|
"phase_id": "string",
|
|
1036
1045
|
"task_type": "MANUAL",
|
|
@@ -1162,6 +1171,7 @@ const { data } = await client.duplicateFlowTemplate({
|
|
|
1162
1171
|
"assigned_to": ["string"],
|
|
1163
1172
|
"ecp": {},
|
|
1164
1173
|
"installer": {},
|
|
1174
|
+
"partner": {},
|
|
1165
1175
|
"taxonomies": ["string"],
|
|
1166
1176
|
"phase_id": "string",
|
|
1167
1177
|
"task_type": "MANUAL"
|
|
@@ -1177,6 +1187,7 @@ const { data } = await client.duplicateFlowTemplate({
|
|
|
1177
1187
|
"assigned_to": ["string"],
|
|
1178
1188
|
"ecp": {},
|
|
1179
1189
|
"installer": {},
|
|
1190
|
+
"partner": {},
|
|
1180
1191
|
"taxonomies": ["string"],
|
|
1181
1192
|
"phase_id": "string",
|
|
1182
1193
|
"task_type": "MANUAL",
|
|
@@ -1220,330 +1231,6 @@ const { data } = await client.duplicateFlowTemplate({
|
|
|
1220
1231
|
|
|
1221
1232
|
---
|
|
1222
1233
|
|
|
1223
|
-
### `exportFlowTemplate`
|
|
1224
|
-
|
|
1225
|
-
Export a Flow Template with all referenced automations resolved and bundled alongside.
|
|
1226
|
-
|
|
1227
|
-
`GET /v2/flows/templates/{flowId}/export`
|
|
1228
|
-
|
|
1229
|
-
```ts
|
|
1230
|
-
const { data } = await client.exportFlowTemplate({
|
|
1231
|
-
flowId: 'example',
|
|
1232
|
-
})
|
|
1233
|
-
```
|
|
1234
|
-
|
|
1235
|
-
<details>
|
|
1236
|
-
<summary>Response</summary>
|
|
1237
|
-
|
|
1238
|
-
```json
|
|
1239
|
-
{
|
|
1240
|
-
"id": "string",
|
|
1241
|
-
"org_id": "string",
|
|
1242
|
-
"name": "string",
|
|
1243
|
-
"description": "string",
|
|
1244
|
-
"trigger": {
|
|
1245
|
-
"type": "automation",
|
|
1246
|
-
"automation_id": "g92j2-sg9ug92hjt1gh-9s9gajgs-a979gg"
|
|
1247
|
-
},
|
|
1248
|
-
"enabled": true,
|
|
1249
|
-
"version": 2,
|
|
1250
|
-
"created_at": "2021-04-27T12:01:13.000Z",
|
|
1251
|
-
"updated_at": "2021-04-27T12:01:13.000Z",
|
|
1252
|
-
"due_date": "2021-04-27T12:00:00.000Z",
|
|
1253
|
-
"due_date_config": {
|
|
1254
|
-
"duration": 0,
|
|
1255
|
-
"unit": "minutes",
|
|
1256
|
-
"type": "WORKFLOW_STARTED",
|
|
1257
|
-
"task_id": "string",
|
|
1258
|
-
"phase_id": "string"
|
|
1259
|
-
},
|
|
1260
|
-
"assigned_to": ["string"],
|
|
1261
|
-
"available_in_ecp": true,
|
|
1262
|
-
"additional_triggers": [
|
|
1263
|
-
{
|
|
1264
|
-
"id": "string",
|
|
1265
|
-
"type": "manual",
|
|
1266
|
-
"entity_schema": "string"
|
|
1267
|
-
},
|
|
1268
|
-
{
|
|
1269
|
-
"id": "string",
|
|
1270
|
-
"type": "automation",
|
|
1271
|
-
"automation_id": "string",
|
|
1272
|
-
"trigger_config": []
|
|
1273
|
-
}
|
|
1274
|
-
],
|
|
1275
|
-
"phases": [
|
|
1276
|
-
{
|
|
1277
|
-
"id": "string",
|
|
1278
|
-
"name": "string",
|
|
1279
|
-
"due_date": "2021-04-27T12:00:00.000Z",
|
|
1280
|
-
"due_date_config": {},
|
|
1281
|
-
"assigned_to": ["string"],
|
|
1282
|
-
"taxonomies": ["string"]
|
|
1283
|
-
}
|
|
1284
|
-
],
|
|
1285
|
-
"tasks": [
|
|
1286
|
-
{
|
|
1287
|
-
"id": "string",
|
|
1288
|
-
"name": "string",
|
|
1289
|
-
"description": {},
|
|
1290
|
-
"journey": {},
|
|
1291
|
-
"due_date": "2021-04-27T12:00:00.000Z",
|
|
1292
|
-
"due_date_config": {},
|
|
1293
|
-
"requirements": [],
|
|
1294
|
-
"assigned_to": ["string"],
|
|
1295
|
-
"ecp": {},
|
|
1296
|
-
"installer": {},
|
|
1297
|
-
"taxonomies": ["string"],
|
|
1298
|
-
"phase_id": "string",
|
|
1299
|
-
"task_type": "MANUAL"
|
|
1300
|
-
},
|
|
1301
|
-
{
|
|
1302
|
-
"id": "string",
|
|
1303
|
-
"name": "string",
|
|
1304
|
-
"description": {},
|
|
1305
|
-
"journey": {},
|
|
1306
|
-
"due_date": "2021-04-27T12:00:00.000Z",
|
|
1307
|
-
"due_date_config": {},
|
|
1308
|
-
"requirements": [],
|
|
1309
|
-
"assigned_to": ["string"],
|
|
1310
|
-
"ecp": {},
|
|
1311
|
-
"installer": {},
|
|
1312
|
-
"taxonomies": ["string"],
|
|
1313
|
-
"phase_id": "string",
|
|
1314
|
-
"task_type": "MANUAL",
|
|
1315
|
-
"automation_config": {},
|
|
1316
|
-
"trigger_mode": "manual",
|
|
1317
|
-
"schedule": {},
|
|
1318
|
-
"created_automatically": false
|
|
1319
|
-
}
|
|
1320
|
-
],
|
|
1321
|
-
"edges": [
|
|
1322
|
-
{
|
|
1323
|
-
"id": "string",
|
|
1324
|
-
"from_id": "string",
|
|
1325
|
-
"to_id": "string",
|
|
1326
|
-
"condition_id": "string",
|
|
1327
|
-
"none_met": true
|
|
1328
|
-
}
|
|
1329
|
-
],
|
|
1330
|
-
"closing_reasons": [
|
|
1331
|
-
{
|
|
1332
|
-
"id": "string",
|
|
1333
|
-
"title": "string",
|
|
1334
|
-
"status": "ACTIVE",
|
|
1335
|
-
"lastUpdateTime": "string",
|
|
1336
|
-
"creationTime": "string"
|
|
1337
|
-
}
|
|
1338
|
-
],
|
|
1339
|
-
"entity_sync": [
|
|
1340
|
-
{
|
|
1341
|
-
"trigger": {},
|
|
1342
|
-
"target": {},
|
|
1343
|
-
"value": {}
|
|
1344
|
-
}
|
|
1345
|
-
],
|
|
1346
|
-
"taxonomies": ["string"],
|
|
1347
|
-
"singleClosingReasonSelection": true,
|
|
1348
|
-
"_resolved_automations": {}
|
|
1349
|
-
}
|
|
1350
|
-
```
|
|
1351
|
-
|
|
1352
|
-
</details>
|
|
1353
|
-
|
|
1354
|
-
---
|
|
1355
|
-
|
|
1356
|
-
### `importFlowTemplate`
|
|
1357
|
-
|
|
1358
|
-
Import a Flow Template from an export payload. Creates all automations and the flow in the caller's organization.
|
|
1359
|
-
|
|
1360
|
-
`POST /v2/flows/templates/import`
|
|
1361
|
-
|
|
1362
|
-
```ts
|
|
1363
|
-
const { data } = await client.importFlowTemplate(
|
|
1364
|
-
null,
|
|
1365
|
-
{
|
|
1366
|
-
id: 'string',
|
|
1367
|
-
org_id: 'string',
|
|
1368
|
-
name: 'string',
|
|
1369
|
-
description: 'string',
|
|
1370
|
-
trigger: {
|
|
1371
|
-
type: 'automation',
|
|
1372
|
-
automation_id: 'g92j2-sg9ug92hjt1gh-9s9gajgs-a979gg'
|
|
1373
|
-
},
|
|
1374
|
-
enabled: true,
|
|
1375
|
-
version: 2,
|
|
1376
|
-
created_at: '2021-04-27T12:01:13.000Z',
|
|
1377
|
-
updated_at: '2021-04-27T12:01:13.000Z',
|
|
1378
|
-
due_date: '2021-04-27T12:00:00.000Z',
|
|
1379
|
-
due_date_config: {
|
|
1380
|
-
duration: 0,
|
|
1381
|
-
unit: 'minutes',
|
|
1382
|
-
type: 'WORKFLOW_STARTED',
|
|
1383
|
-
task_id: 'string',
|
|
1384
|
-
phase_id: 'string'
|
|
1385
|
-
},
|
|
1386
|
-
assigned_to: ['string'],
|
|
1387
|
-
available_in_ecp: true,
|
|
1388
|
-
additional_triggers: [
|
|
1389
|
-
{
|
|
1390
|
-
id: 'string',
|
|
1391
|
-
type: 'manual',
|
|
1392
|
-
entity_schema: 'string'
|
|
1393
|
-
},
|
|
1394
|
-
{
|
|
1395
|
-
id: 'string',
|
|
1396
|
-
type: 'automation',
|
|
1397
|
-
automation_id: 'string',
|
|
1398
|
-
trigger_config: [ /* ... */ ]
|
|
1399
|
-
},
|
|
1400
|
-
/* ... 2 more */
|
|
1401
|
-
],
|
|
1402
|
-
phases: [
|
|
1403
|
-
{
|
|
1404
|
-
id: 'string',
|
|
1405
|
-
name: 'string',
|
|
1406
|
-
due_date: '2021-04-27T12:00:00.000Z',
|
|
1407
|
-
due_date_config: { /* ... */ },
|
|
1408
|
-
assigned_to: ['string'],
|
|
1409
|
-
taxonomies: ['string']
|
|
1410
|
-
}
|
|
1411
|
-
],
|
|
1412
|
-
tasks: [
|
|
1413
|
-
{
|
|
1414
|
-
id: 'string',
|
|
1415
|
-
name: 'string',
|
|
1416
|
-
description: { /* ... */ },
|
|
1417
|
-
journey: { /* ... */ },
|
|
1418
|
-
due_date: '2021-04-27T12:00:00.000Z',
|
|
1419
|
-
due_date_config: { /* ... */ },
|
|
1420
|
-
requirements: [ /* ... */ ],
|
|
1421
|
-
assigned_to: ['string'],
|
|
1422
|
-
ecp: { /* ... */ },
|
|
1423
|
-
installer: { /* ... */ },
|
|
1424
|
-
taxonomies: ['string'],
|
|
1425
|
-
phase_id: 'string',
|
|
1426
|
-
task_type: 'MANUAL'
|
|
1427
|
-
},
|
|
1428
|
-
{
|
|
1429
|
-
id: 'string',
|
|
1430
|
-
name: 'string',
|
|
1431
|
-
description: { /* ... */ },
|
|
1432
|
-
journey: { /* ... */ },
|
|
1433
|
-
due_date: '2021-04-27T12:00:00.000Z',
|
|
1434
|
-
due_date_config: { /* ... */ },
|
|
1435
|
-
requirements: [ /* ... */ ],
|
|
1436
|
-
assigned_to: ['string'],
|
|
1437
|
-
ecp: { /* ... */ },
|
|
1438
|
-
installer: { /* ... */ },
|
|
1439
|
-
taxonomies: ['string'],
|
|
1440
|
-
phase_id: 'string',
|
|
1441
|
-
task_type: 'MANUAL',
|
|
1442
|
-
automation_config: { /* ... */ },
|
|
1443
|
-
trigger_mode: 'manual',
|
|
1444
|
-
schedule: { /* ... */ },
|
|
1445
|
-
created_automatically: false
|
|
1446
|
-
},
|
|
1447
|
-
/* ... 2 more */
|
|
1448
|
-
],
|
|
1449
|
-
edges: [
|
|
1450
|
-
{
|
|
1451
|
-
id: 'string',
|
|
1452
|
-
from_id: 'string',
|
|
1453
|
-
to_id: 'string',
|
|
1454
|
-
condition_id: 'string',
|
|
1455
|
-
none_met: true
|
|
1456
|
-
}
|
|
1457
|
-
],
|
|
1458
|
-
closing_reasons: [
|
|
1459
|
-
{
|
|
1460
|
-
id: 'string',
|
|
1461
|
-
title: 'string',
|
|
1462
|
-
status: 'ACTIVE',
|
|
1463
|
-
lastUpdateTime: 'string',
|
|
1464
|
-
creationTime: 'string'
|
|
1465
|
-
}
|
|
1466
|
-
],
|
|
1467
|
-
entity_sync: [
|
|
1468
|
-
{
|
|
1469
|
-
trigger: { /* ... */ },
|
|
1470
|
-
target: { /* ... */ },
|
|
1471
|
-
value: { /* ... */ }
|
|
1472
|
-
}
|
|
1473
|
-
],
|
|
1474
|
-
taxonomies: ['string'],
|
|
1475
|
-
singleClosingReasonSelection: true,
|
|
1476
|
-
_resolved_automations: {}
|
|
1477
|
-
},
|
|
1478
|
-
)
|
|
1479
|
-
```
|
|
1480
|
-
|
|
1481
|
-
<details>
|
|
1482
|
-
<summary>Response</summary>
|
|
1483
|
-
|
|
1484
|
-
```json
|
|
1485
|
-
{
|
|
1486
|
-
"flow": {
|
|
1487
|
-
"id": "string",
|
|
1488
|
-
"org_id": "string",
|
|
1489
|
-
"name": "string",
|
|
1490
|
-
"description": "string",
|
|
1491
|
-
"trigger": {
|
|
1492
|
-
"type": "automation",
|
|
1493
|
-
"automation_id": "g92j2-sg9ug92hjt1gh-9s9gajgs-a979gg"
|
|
1494
|
-
},
|
|
1495
|
-
"enabled": true,
|
|
1496
|
-
"version": 2,
|
|
1497
|
-
"created_at": "2021-04-27T12:01:13.000Z",
|
|
1498
|
-
"updated_at": "2021-04-27T12:01:13.000Z",
|
|
1499
|
-
"due_date": "2021-04-27T12:00:00.000Z",
|
|
1500
|
-
"due_date_config": {
|
|
1501
|
-
"duration": 0,
|
|
1502
|
-
"unit": "minutes",
|
|
1503
|
-
"type": "WORKFLOW_STARTED",
|
|
1504
|
-
"task_id": "string",
|
|
1505
|
-
"phase_id": "string"
|
|
1506
|
-
},
|
|
1507
|
-
"assigned_to": ["string"],
|
|
1508
|
-
"available_in_ecp": true,
|
|
1509
|
-
"additional_triggers": [
|
|
1510
|
-
{},
|
|
1511
|
-
{}
|
|
1512
|
-
],
|
|
1513
|
-
"phases": [
|
|
1514
|
-
{}
|
|
1515
|
-
],
|
|
1516
|
-
"tasks": [
|
|
1517
|
-
{},
|
|
1518
|
-
{}
|
|
1519
|
-
],
|
|
1520
|
-
"edges": [
|
|
1521
|
-
{}
|
|
1522
|
-
],
|
|
1523
|
-
"closing_reasons": [
|
|
1524
|
-
{}
|
|
1525
|
-
],
|
|
1526
|
-
"entity_sync": [
|
|
1527
|
-
{}
|
|
1528
|
-
],
|
|
1529
|
-
"taxonomies": ["string"],
|
|
1530
|
-
"singleClosingReasonSelection": true
|
|
1531
|
-
},
|
|
1532
|
-
"_id_mappings": {
|
|
1533
|
-
"flow_id": {
|
|
1534
|
-
"old": "string",
|
|
1535
|
-
"new": "string"
|
|
1536
|
-
},
|
|
1537
|
-
"task_ids": {},
|
|
1538
|
-
"automation_ids": {}
|
|
1539
|
-
}
|
|
1540
|
-
}
|
|
1541
|
-
```
|
|
1542
|
-
|
|
1543
|
-
</details>
|
|
1544
|
-
|
|
1545
|
-
---
|
|
1546
|
-
|
|
1547
1234
|
### `getDefinition`
|
|
1548
1235
|
|
|
1549
1236
|
Get specific Definition by id from the Organization.
|
|
@@ -1606,6 +1293,7 @@ const { data } = await client.getDefinition({
|
|
|
1606
1293
|
"type": "STEP",
|
|
1607
1294
|
"ecp": {},
|
|
1608
1295
|
"installer": {},
|
|
1296
|
+
"partner": {},
|
|
1609
1297
|
"taxonomies": ["string"]
|
|
1610
1298
|
}
|
|
1611
1299
|
],
|
|
@@ -1686,6 +1374,7 @@ const { data } = await client.updateDefinition(
|
|
|
1686
1374
|
type: 'STEP',
|
|
1687
1375
|
ecp: { /* ... */ },
|
|
1688
1376
|
installer: { /* ... */ },
|
|
1377
|
+
partner: { /* ... */ },
|
|
1689
1378
|
taxonomies: ['string']
|
|
1690
1379
|
}
|
|
1691
1380
|
],
|
|
@@ -1756,6 +1445,7 @@ const { data } = await client.updateDefinition(
|
|
|
1756
1445
|
"type": "STEP",
|
|
1757
1446
|
"ecp": {},
|
|
1758
1447
|
"installer": {},
|
|
1448
|
+
"partner": {},
|
|
1759
1449
|
"taxonomies": ["string"]
|
|
1760
1450
|
}
|
|
1761
1451
|
],
|
|
@@ -2055,13 +1745,13 @@ type FlowTemplateBase = {
|
|
|
2055
1745
|
due_date_config?: {
|
|
2056
1746
|
duration: number
|
|
2057
1747
|
unit: "minutes" | "hours" | "days" | "weeks" | "months"
|
|
2058
|
-
type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED"
|
|
1748
|
+
type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"
|
|
2059
1749
|
task_id?: string
|
|
2060
1750
|
phase_id?: string
|
|
2061
1751
|
}
|
|
2062
1752
|
assigned_to?: Array<string | {
|
|
2063
1753
|
variable: string
|
|
2064
|
-
value?: string
|
|
1754
|
+
value?: string[]
|
|
2065
1755
|
}>
|
|
2066
1756
|
available_in_ecp?: boolean
|
|
2067
1757
|
additional_triggers?: Array<{
|
|
@@ -2162,13 +1852,13 @@ type FlowTemplate = {
|
|
|
2162
1852
|
due_date_config?: {
|
|
2163
1853
|
duration: number
|
|
2164
1854
|
unit: "minutes" | "hours" | "days" | "weeks" | "months"
|
|
2165
|
-
type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED"
|
|
1855
|
+
type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"
|
|
2166
1856
|
task_id?: string
|
|
2167
1857
|
phase_id?: string
|
|
2168
1858
|
}
|
|
2169
1859
|
assigned_to?: Array<string | {
|
|
2170
1860
|
variable: string
|
|
2171
|
-
value?: string
|
|
1861
|
+
value?: string[]
|
|
2172
1862
|
}>
|
|
2173
1863
|
available_in_ecp?: boolean
|
|
2174
1864
|
additional_triggers?: Array<{
|
|
@@ -2234,9 +1924,9 @@ type FlowTemplate = {
|
|
|
2234
1924
|
|
|
2235
1925
|
Version of the workflow schema.
|
|
2236
1926
|
|
|
2237
|
-
- `v1` – *Deprecated*. The initial version of workflows with limited structure and automation capabilities.
|
|
2238
|
-
- `v2` – Linear workflows. Supports sequential task execution with basic automation triggers.
|
|
2239
|
-
- `v3` – Advanced workflows. Adds support for branching logic
|
|
1927
|
+
- `v1` – *Deprecated*. The initial version of workflows with limited structure and automation capabilities.
|
|
1928
|
+
- `v2` – Linear workflows. Supports sequential task execution with basic automation triggers.
|
|
1929
|
+
- `v3` – Advanced workflows. Adds support for branching logic (co
|
|
2240
1930
|
|
|
2241
1931
|
```ts
|
|
2242
1932
|
type Version = "v1" | "v2" | "v3"
|
|
@@ -2355,13 +2045,13 @@ type CreateFlowTemplate = {
|
|
|
2355
2045
|
due_date_config?: {
|
|
2356
2046
|
duration: number
|
|
2357
2047
|
unit: "minutes" | "hours" | "days" | "weeks" | "months"
|
|
2358
|
-
type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED"
|
|
2048
|
+
type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"
|
|
2359
2049
|
task_id?: string
|
|
2360
2050
|
phase_id?: string
|
|
2361
2051
|
}
|
|
2362
2052
|
assigned_to?: Array<string | {
|
|
2363
2053
|
variable: string
|
|
2364
|
-
value?: string
|
|
2054
|
+
value?: string[]
|
|
2365
2055
|
}>
|
|
2366
2056
|
available_in_ecp?: boolean
|
|
2367
2057
|
additional_triggers?: Array<{
|
|
@@ -2523,6 +2213,7 @@ type FlowTemplatesList = {
|
|
|
2523
2213
|
assigned_to?: { ... }
|
|
2524
2214
|
ecp?: { ... }
|
|
2525
2215
|
installer?: { ... }
|
|
2216
|
+
partner?: { ... }
|
|
2526
2217
|
taxonomies?: { ... }
|
|
2527
2218
|
phase_id?: { ... }
|
|
2528
2219
|
task_type: { ... }
|
|
@@ -2537,10 +2228,9 @@ type FlowTemplatesList = {
|
|
|
2537
2228
|
assigned_to?: { ... }
|
|
2538
2229
|
ecp?: { ... }
|
|
2539
2230
|
installer?: { ... }
|
|
2231
|
+
partner?: { ... }
|
|
2540
2232
|
taxonomies?: { ... }
|
|
2541
2233
|
phase_id?: { ... }
|
|
2542
|
-
task_type: { ... }
|
|
2543
|
-
automation_config: { ... }
|
|
2544
2234
|
// ...
|
|
2545
2235
|
}
|
|
2546
2236
|
```
|
|
@@ -2573,7 +2263,7 @@ type Task = {
|
|
|
2573
2263
|
due_date_config?: {
|
|
2574
2264
|
duration: number
|
|
2575
2265
|
unit: "minutes" | "hours" | "days" | "weeks" | "months"
|
|
2576
|
-
type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED"
|
|
2266
|
+
type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"
|
|
2577
2267
|
task_id?: string
|
|
2578
2268
|
phase_id?: string
|
|
2579
2269
|
}
|
|
@@ -2584,7 +2274,7 @@ type Task = {
|
|
|
2584
2274
|
}>
|
|
2585
2275
|
assigned_to?: Array<string | {
|
|
2586
2276
|
variable: string
|
|
2587
|
-
value?: string
|
|
2277
|
+
value?: string[]
|
|
2588
2278
|
}>
|
|
2589
2279
|
ecp?: {
|
|
2590
2280
|
enabled?: boolean
|
|
@@ -2608,6 +2298,11 @@ type Task = {
|
|
|
2608
2298
|
complete_task_automatically?: { ... }
|
|
2609
2299
|
}
|
|
2610
2300
|
}
|
|
2301
|
+
partner?: {
|
|
2302
|
+
enabled?: boolean
|
|
2303
|
+
label?: string
|
|
2304
|
+
description?: string
|
|
2305
|
+
}
|
|
2611
2306
|
taxonomies?: string[]
|
|
2612
2307
|
phase_id?: string
|
|
2613
2308
|
task_type: "MANUAL" | "AUTOMATION" | "DECISION" | "AI_AGENT"
|
|
@@ -2628,7 +2323,7 @@ type Task = {
|
|
|
2628
2323
|
due_date_config?: {
|
|
2629
2324
|
duration: number
|
|
2630
2325
|
unit: "minutes" | "hours" | "days" | "weeks" | "months"
|
|
2631
|
-
type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED"
|
|
2326
|
+
type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"
|
|
2632
2327
|
task_id?: string
|
|
2633
2328
|
phase_id?: string
|
|
2634
2329
|
}
|
|
@@ -2639,7 +2334,7 @@ type Task = {
|
|
|
2639
2334
|
}>
|
|
2640
2335
|
assigned_to?: Array<string | {
|
|
2641
2336
|
variable: string
|
|
2642
|
-
value?: string
|
|
2337
|
+
value?: string[]
|
|
2643
2338
|
}>
|
|
2644
2339
|
ecp?: {
|
|
2645
2340
|
enabled?: boolean
|
|
@@ -2651,11 +2346,6 @@ type Task = {
|
|
|
2651
2346
|
name?: { ... }
|
|
2652
2347
|
complete_task_automatically?: { ... }
|
|
2653
2348
|
}
|
|
2654
|
-
}
|
|
2655
|
-
installer?: {
|
|
2656
|
-
enabled?: boolean
|
|
2657
|
-
label?: string
|
|
2658
|
-
description?: string
|
|
2659
2349
|
// ...
|
|
2660
2350
|
}
|
|
2661
2351
|
```
|
|
@@ -2680,7 +2370,7 @@ type ManualTask = {
|
|
|
2680
2370
|
due_date_config?: {
|
|
2681
2371
|
duration: number
|
|
2682
2372
|
unit: "minutes" | "hours" | "days" | "weeks" | "months"
|
|
2683
|
-
type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED"
|
|
2373
|
+
type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"
|
|
2684
2374
|
task_id?: string
|
|
2685
2375
|
phase_id?: string
|
|
2686
2376
|
}
|
|
@@ -2691,7 +2381,7 @@ type ManualTask = {
|
|
|
2691
2381
|
}>
|
|
2692
2382
|
assigned_to?: Array<string | {
|
|
2693
2383
|
variable: string
|
|
2694
|
-
value?: string
|
|
2384
|
+
value?: string[]
|
|
2695
2385
|
}>
|
|
2696
2386
|
ecp?: {
|
|
2697
2387
|
enabled?: boolean
|
|
@@ -2715,6 +2405,11 @@ type ManualTask = {
|
|
|
2715
2405
|
complete_task_automatically?: { ... }
|
|
2716
2406
|
}
|
|
2717
2407
|
}
|
|
2408
|
+
partner?: {
|
|
2409
|
+
enabled?: boolean
|
|
2410
|
+
label?: string
|
|
2411
|
+
description?: string
|
|
2412
|
+
}
|
|
2718
2413
|
taxonomies?: string[]
|
|
2719
2414
|
phase_id?: string
|
|
2720
2415
|
task_type: "MANUAL" | "AUTOMATION" | "DECISION" | "AI_AGENT"
|
|
@@ -2741,7 +2436,7 @@ type AutomationTask = {
|
|
|
2741
2436
|
due_date_config?: {
|
|
2742
2437
|
duration: number
|
|
2743
2438
|
unit: "minutes" | "hours" | "days" | "weeks" | "months"
|
|
2744
|
-
type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED"
|
|
2439
|
+
type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"
|
|
2745
2440
|
task_id?: string
|
|
2746
2441
|
phase_id?: string
|
|
2747
2442
|
}
|
|
@@ -2752,7 +2447,7 @@ type AutomationTask = {
|
|
|
2752
2447
|
}>
|
|
2753
2448
|
assigned_to?: Array<string | {
|
|
2754
2449
|
variable: string
|
|
2755
|
-
value?: string
|
|
2450
|
+
value?: string[]
|
|
2756
2451
|
}>
|
|
2757
2452
|
ecp?: {
|
|
2758
2453
|
enabled?: boolean
|
|
@@ -2776,6 +2471,11 @@ type AutomationTask = {
|
|
|
2776
2471
|
complete_task_automatically?: { ... }
|
|
2777
2472
|
}
|
|
2778
2473
|
}
|
|
2474
|
+
partner?: {
|
|
2475
|
+
enabled?: boolean
|
|
2476
|
+
label?: string
|
|
2477
|
+
description?: string
|
|
2478
|
+
}
|
|
2779
2479
|
taxonomies?: string[]
|
|
2780
2480
|
phase_id?: string
|
|
2781
2481
|
task_type: "MANUAL" | "AUTOMATION" | "DECISION" | "AI_AGENT"
|
|
@@ -2843,7 +2543,7 @@ type AiAgentTask = {
|
|
|
2843
2543
|
due_date_config?: {
|
|
2844
2544
|
duration: number
|
|
2845
2545
|
unit: "minutes" | "hours" | "days" | "weeks" | "months"
|
|
2846
|
-
type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED"
|
|
2546
|
+
type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"
|
|
2847
2547
|
task_id?: string
|
|
2848
2548
|
phase_id?: string
|
|
2849
2549
|
}
|
|
@@ -2854,7 +2554,7 @@ type AiAgentTask = {
|
|
|
2854
2554
|
}>
|
|
2855
2555
|
assigned_to?: Array<string | {
|
|
2856
2556
|
variable: string
|
|
2857
|
-
value?: string
|
|
2557
|
+
value?: string[]
|
|
2858
2558
|
}>
|
|
2859
2559
|
ecp?: {
|
|
2860
2560
|
enabled?: boolean
|
|
@@ -2878,6 +2578,11 @@ type AiAgentTask = {
|
|
|
2878
2578
|
complete_task_automatically?: { ... }
|
|
2879
2579
|
}
|
|
2880
2580
|
}
|
|
2581
|
+
partner?: {
|
|
2582
|
+
enabled?: boolean
|
|
2583
|
+
label?: string
|
|
2584
|
+
description?: string
|
|
2585
|
+
}
|
|
2881
2586
|
taxonomies?: string[]
|
|
2882
2587
|
phase_id?: string
|
|
2883
2588
|
task_type: "MANUAL" | "AUTOMATION" | "DECISION" | "AI_AGENT"
|
|
@@ -2919,7 +2624,7 @@ type ActionSchedule = {
|
|
|
2919
2624
|
unit: "minutes" | "hours" | "days" | "weeks" | "months"
|
|
2920
2625
|
reference: {
|
|
2921
2626
|
id: string
|
|
2922
|
-
origin: "flow_started" | "task_completed" | "trigger_entity_attribute"
|
|
2627
|
+
origin: "flow_started" | "task_completed" | "trigger_entity_attribute" | "all_preceding_tasks_completed"
|
|
2923
2628
|
schema?: string
|
|
2924
2629
|
attribute?: string
|
|
2925
2630
|
}
|
|
@@ -2954,7 +2659,7 @@ type RelativeSchedule = {
|
|
|
2954
2659
|
unit: "minutes" | "hours" | "days" | "weeks" | "months"
|
|
2955
2660
|
reference: {
|
|
2956
2661
|
id: string
|
|
2957
|
-
origin: "flow_started" | "task_completed" | "trigger_entity_attribute"
|
|
2662
|
+
origin: "flow_started" | "task_completed" | "trigger_entity_attribute" | "all_preceding_tasks_completed"
|
|
2958
2663
|
schema?: string
|
|
2959
2664
|
attribute?: string
|
|
2960
2665
|
}
|
|
@@ -2981,7 +2686,7 @@ type DecisionTask = {
|
|
|
2981
2686
|
due_date_config?: {
|
|
2982
2687
|
duration: number
|
|
2983
2688
|
unit: "minutes" | "hours" | "days" | "weeks" | "months"
|
|
2984
|
-
type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED"
|
|
2689
|
+
type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"
|
|
2985
2690
|
task_id?: string
|
|
2986
2691
|
phase_id?: string
|
|
2987
2692
|
}
|
|
@@ -2992,7 +2697,7 @@ type DecisionTask = {
|
|
|
2992
2697
|
}>
|
|
2993
2698
|
assigned_to?: Array<string | {
|
|
2994
2699
|
variable: string
|
|
2995
|
-
value?: string
|
|
2700
|
+
value?: string[]
|
|
2996
2701
|
}>
|
|
2997
2702
|
ecp?: {
|
|
2998
2703
|
enabled?: boolean
|
|
@@ -3016,6 +2721,11 @@ type DecisionTask = {
|
|
|
3016
2721
|
complete_task_automatically?: { ... }
|
|
3017
2722
|
}
|
|
3018
2723
|
}
|
|
2724
|
+
partner?: {
|
|
2725
|
+
enabled?: boolean
|
|
2726
|
+
label?: string
|
|
2727
|
+
description?: string
|
|
2728
|
+
}
|
|
3019
2729
|
taxonomies?: string[]
|
|
3020
2730
|
phase_id?: string
|
|
3021
2731
|
task_type: "MANUAL" | "AUTOMATION" | "DECISION" | "AI_AGENT"
|
|
@@ -3029,6 +2739,7 @@ type DecisionTask = {
|
|
|
3029
2739
|
source: { ... }
|
|
3030
2740
|
operator: { ... }
|
|
3031
2741
|
values: { ... }
|
|
2742
|
+
value_type?: { ... }
|
|
3032
2743
|
}>
|
|
3033
2744
|
}>
|
|
3034
2745
|
schedule?: {
|
|
@@ -3075,7 +2786,7 @@ type TaskBase = {
|
|
|
3075
2786
|
due_date_config?: {
|
|
3076
2787
|
duration: number
|
|
3077
2788
|
unit: "minutes" | "hours" | "days" | "weeks" | "months"
|
|
3078
|
-
type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED"
|
|
2789
|
+
type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"
|
|
3079
2790
|
task_id?: string
|
|
3080
2791
|
phase_id?: string
|
|
3081
2792
|
}
|
|
@@ -3086,7 +2797,7 @@ type TaskBase = {
|
|
|
3086
2797
|
}>
|
|
3087
2798
|
assigned_to?: Array<string | {
|
|
3088
2799
|
variable: string
|
|
3089
|
-
value?: string
|
|
2800
|
+
value?: string[]
|
|
3090
2801
|
}>
|
|
3091
2802
|
ecp?: {
|
|
3092
2803
|
enabled?: boolean
|
|
@@ -3110,6 +2821,11 @@ type TaskBase = {
|
|
|
3110
2821
|
complete_task_automatically?: { ... }
|
|
3111
2822
|
}
|
|
3112
2823
|
}
|
|
2824
|
+
partner?: {
|
|
2825
|
+
enabled?: boolean
|
|
2826
|
+
label?: string
|
|
2827
|
+
description?: string
|
|
2828
|
+
}
|
|
3113
2829
|
taxonomies?: string[]
|
|
3114
2830
|
phase_id?: string
|
|
3115
2831
|
task_type: "MANUAL" | "AUTOMATION" | "DECISION" | "AI_AGENT"
|
|
@@ -3126,13 +2842,13 @@ type Phase = {
|
|
|
3126
2842
|
due_date_config?: {
|
|
3127
2843
|
duration: number
|
|
3128
2844
|
unit: "minutes" | "hours" | "days" | "weeks" | "months"
|
|
3129
|
-
type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED"
|
|
2845
|
+
type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"
|
|
3130
2846
|
task_id?: string
|
|
3131
2847
|
phase_id?: string
|
|
3132
2848
|
}
|
|
3133
2849
|
assigned_to?: Array<string | {
|
|
3134
2850
|
variable: string
|
|
3135
|
-
value?: string
|
|
2851
|
+
value?: string[]
|
|
3136
2852
|
}>
|
|
3137
2853
|
taxonomies?: string[]
|
|
3138
2854
|
}
|
|
@@ -3145,7 +2861,7 @@ Represents a variable assignment with its expression and optional resolved value
|
|
|
3145
2861
|
```ts
|
|
3146
2862
|
type VariableAssignment = {
|
|
3147
2863
|
variable: string
|
|
3148
|
-
value?: string
|
|
2864
|
+
value?: string[]
|
|
3149
2865
|
}
|
|
3150
2866
|
```
|
|
3151
2867
|
|
|
@@ -3161,7 +2877,7 @@ type TaskType = "MANUAL" | "AUTOMATION" | "DECISION" | "AI_AGENT"
|
|
|
3161
2877
|
type Edge = {
|
|
3162
2878
|
id: string
|
|
3163
2879
|
from_id: string
|
|
3164
|
-
to_id
|
|
2880
|
+
to_id?: string
|
|
3165
2881
|
condition_id?: string
|
|
3166
2882
|
none_met?: boolean
|
|
3167
2883
|
}
|
|
@@ -3186,9 +2902,11 @@ type Condition = {
|
|
|
3186
2902
|
attribute_repeatable?: { ... }
|
|
3187
2903
|
attribute_operation?: { ... }
|
|
3188
2904
|
attribute_sub_field?: { ... }
|
|
2905
|
+
date_offset?: { ... }
|
|
3189
2906
|
}
|
|
3190
2907
|
operator: "equals" | "not_equals" | "any_of" | "none_of" | "contains" | "not_contains" | "starts_with" | "ends_with" | "greater_than" | "less_than" | "greater_than_or_equals" | "less_than_or_equals" | "is_empty" | "is_not_empty"
|
|
3191
2908
|
values: string[]
|
|
2909
|
+
value_type?: "static" | "relative_date"
|
|
3192
2910
|
}>
|
|
3193
2911
|
}
|
|
3194
2912
|
```
|
|
@@ -3208,9 +2926,14 @@ type Statement = {
|
|
|
3208
2926
|
attribute_repeatable?: boolean
|
|
3209
2927
|
attribute_operation?: "all" | "updated" | "added" | "deleted"
|
|
3210
2928
|
attribute_sub_field?: string
|
|
2929
|
+
date_offset?: {
|
|
2930
|
+
amount?: { ... }
|
|
2931
|
+
unit?: { ... }
|
|
2932
|
+
}
|
|
3211
2933
|
}
|
|
3212
2934
|
operator: "equals" | "not_equals" | "any_of" | "none_of" | "contains" | "not_contains" | "starts_with" | "ends_with" | "greater_than" | "less_than" | "greater_than_or_equals" | "less_than_or_equals" | "is_empty" | "is_not_empty"
|
|
3213
2935
|
values: string[]
|
|
2936
|
+
value_type?: "static" | "relative_date"
|
|
3214
2937
|
}
|
|
3215
2938
|
```
|
|
3216
2939
|
|
|
@@ -3227,6 +2950,10 @@ type EvaluationSource = {
|
|
|
3227
2950
|
attribute_repeatable?: boolean
|
|
3228
2951
|
attribute_operation?: "all" | "updated" | "added" | "deleted"
|
|
3229
2952
|
attribute_sub_field?: string
|
|
2953
|
+
date_offset?: {
|
|
2954
|
+
amount?: number
|
|
2955
|
+
unit?: "days" | "months" | "years"
|
|
2956
|
+
}
|
|
3230
2957
|
}
|
|
3231
2958
|
```
|
|
3232
2959
|
|
|
@@ -3244,7 +2971,7 @@ Set due date for the task based on a dynamic condition
|
|
|
3244
2971
|
type DueDateConfig = {
|
|
3245
2972
|
duration: number
|
|
3246
2973
|
unit: "minutes" | "hours" | "days" | "weeks" | "months"
|
|
3247
|
-
type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED"
|
|
2974
|
+
type: "WORKFLOW_STARTED" | "TASK_FINISHED" | "PHASE_FINISHED" | "A_PRECEDING_TASK_COMPLETED" | "ALL_PRECEDING_TASKS_COMPLETED"
|
|
3248
2975
|
task_id?: string
|
|
3249
2976
|
phase_id?: string
|
|
3250
2977
|
}
|
|
@@ -3319,6 +3046,7 @@ type WorkflowDefinition = {
|
|
|
3319
3046
|
type: { ... }
|
|
3320
3047
|
ecp?: { ... }
|
|
3321
3048
|
installer?: { ... }
|
|
3049
|
+
partner?: { ... }
|
|
3322
3050
|
taxonomies?: { ... }
|
|
3323
3051
|
}>
|
|
3324
3052
|
taxonomies?: string[]
|
|
@@ -3368,9 +3096,8 @@ type WorkflowDefinition = {
|
|
|
3368
3096
|
description?: { ... }
|
|
3369
3097
|
journey?: { ... }
|
|
3370
3098
|
}
|
|
3371
|
-
|
|
3372
|
-
|
|
3373
|
-
closingReasons?: Array<{
|
|
3099
|
+
partner?: {
|
|
3100
|
+
enabled?: { ... }
|
|
3374
3101
|
// ...
|
|
3375
3102
|
}
|
|
3376
3103
|
```
|
|
@@ -3436,6 +3163,11 @@ type Step = {
|
|
|
3436
3163
|
complete_task_automatically?: { ... }
|
|
3437
3164
|
}
|
|
3438
3165
|
}
|
|
3166
|
+
partner?: {
|
|
3167
|
+
enabled?: boolean
|
|
3168
|
+
label?: string
|
|
3169
|
+
description?: string
|
|
3170
|
+
}
|
|
3439
3171
|
taxonomies?: string[]
|
|
3440
3172
|
}
|
|
3441
3173
|
```
|
|
@@ -3505,6 +3237,11 @@ type Section = {
|
|
|
3505
3237
|
description?: { ... }
|
|
3506
3238
|
journey?: { ... }
|
|
3507
3239
|
}
|
|
3240
|
+
partner?: {
|
|
3241
|
+
enabled?: { ... }
|
|
3242
|
+
label?: { ... }
|
|
3243
|
+
description?: { ... }
|
|
3244
|
+
}
|
|
3508
3245
|
taxonomies?: string[]
|
|
3509
3246
|
}>
|
|
3510
3247
|
taxonomies?: string[]
|
|
@@ -3558,6 +3295,18 @@ type ECPDetails = {
|
|
|
3558
3295
|
}
|
|
3559
3296
|
```
|
|
3560
3297
|
|
|
3298
|
+
### `PartnerDetails`
|
|
3299
|
+
|
|
3300
|
+
Details regarding partner for the workflow step
|
|
3301
|
+
|
|
3302
|
+
```ts
|
|
3303
|
+
type PartnerDetails = {
|
|
3304
|
+
enabled?: boolean
|
|
3305
|
+
label?: string
|
|
3306
|
+
description?: string
|
|
3307
|
+
}
|
|
3308
|
+
```
|
|
3309
|
+
|
|
3561
3310
|
### `StepDescription`
|
|
3562
3311
|
|
|
3563
3312
|
Longer information regarding Task
|
|
@@ -3612,8 +3361,8 @@ type ChangeReasonStatusReq = {
|
|
|
3612
3361
|
type ClosingReasons = {
|
|
3613
3362
|
reasons: Array<{
|
|
3614
3363
|
id?: string
|
|
3615
|
-
title
|
|
3616
|
-
status
|
|
3364
|
+
title?: string
|
|
3365
|
+
status?: "ACTIVE" | "INACTIVE"
|
|
3617
3366
|
lastUpdateTime?: string
|
|
3618
3367
|
creationTime?: string
|
|
3619
3368
|
}>
|
|
@@ -3627,8 +3376,8 @@ One Closing reason for a workflow
|
|
|
3627
3376
|
```ts
|
|
3628
3377
|
type ClosingReason = {
|
|
3629
3378
|
id?: string
|
|
3630
|
-
title
|
|
3631
|
-
status
|
|
3379
|
+
title?: string
|
|
3380
|
+
status?: "ACTIVE" | "INACTIVE"
|
|
3632
3381
|
lastUpdateTime?: string
|
|
3633
3382
|
creationTime?: string
|
|
3634
3383
|
}
|
|
@@ -3725,118 +3474,3 @@ type StepRequirement = {
|
|
|
3725
3474
|
condition: "CLOSED"
|
|
3726
3475
|
}
|
|
3727
3476
|
```
|
|
3728
|
-
|
|
3729
|
-
### `FlowTemplateExport`
|
|
3730
|
-
|
|
3731
|
-
```ts
|
|
3732
|
-
type FlowTemplateExport = {
|
|
3733
|
-
_resolved_automations?: Record<string, object>
|
|
3734
|
-
}
|
|
3735
|
-
```
|
|
3736
|
-
|
|
3737
|
-
### `FlowTemplateImportResult`
|
|
3738
|
-
|
|
3739
|
-
```ts
|
|
3740
|
-
type FlowTemplateImportResult = {
|
|
3741
|
-
flow?: {
|
|
3742
|
-
id?: string
|
|
3743
|
-
org_id?: string
|
|
3744
|
-
name: string
|
|
3745
|
-
description?: string
|
|
3746
|
-
trigger?: {
|
|
3747
|
-
id?: { ... }
|
|
3748
|
-
type: { ... }
|
|
3749
|
-
entity_schema?: { ... }
|
|
3750
|
-
} | {
|
|
3751
|
-
id?: { ... }
|
|
3752
|
-
type: { ... }
|
|
3753
|
-
automation_id?: { ... }
|
|
3754
|
-
trigger_config?: { ... }
|
|
3755
|
-
} | {
|
|
3756
|
-
id?: { ... }
|
|
3757
|
-
type: { ... }
|
|
3758
|
-
journey_id: { ... }
|
|
3759
|
-
journey_name?: { ... }
|
|
3760
|
-
automation_id?: { ... }
|
|
3761
|
-
} | {
|
|
3762
|
-
id?: { ... }
|
|
3763
|
-
type: { ... }
|
|
3764
|
-
entity_schema?: { ... }
|
|
3765
|
-
}
|
|
3766
|
-
enabled?: boolean
|
|
3767
|
-
version?: "v1" | "v2" | "v3"
|
|
3768
|
-
created_at?: string
|
|
3769
|
-
updated_at?: string
|
|
3770
|
-
due_date?: string
|
|
3771
|
-
due_date_config?: {
|
|
3772
|
-
duration: { ... }
|
|
3773
|
-
unit: { ... }
|
|
3774
|
-
type: { ... }
|
|
3775
|
-
task_id?: { ... }
|
|
3776
|
-
phase_id?: { ... }
|
|
3777
|
-
}
|
|
3778
|
-
assigned_to?: Array<string | {
|
|
3779
|
-
variable: { ... }
|
|
3780
|
-
value?: { ... }
|
|
3781
|
-
}>
|
|
3782
|
-
available_in_ecp?: boolean
|
|
3783
|
-
additional_triggers?: Array<{
|
|
3784
|
-
id?: { ... }
|
|
3785
|
-
type: { ... }
|
|
3786
|
-
entity_schema?: { ... }
|
|
3787
|
-
} | {
|
|
3788
|
-
id?: { ... }
|
|
3789
|
-
type: { ... }
|
|
3790
|
-
automation_id?: { ... }
|
|
3791
|
-
trigger_config?: { ... }
|
|
3792
|
-
} | {
|
|
3793
|
-
id?: { ... }
|
|
3794
|
-
type: { ... }
|
|
3795
|
-
journey_id: { ... }
|
|
3796
|
-
journey_name?: { ... }
|
|
3797
|
-
automation_id?: { ... }
|
|
3798
|
-
} | {
|
|
3799
|
-
id?: { ... }
|
|
3800
|
-
type: { ... }
|
|
3801
|
-
entity_schema?: { ... }
|
|
3802
|
-
}>
|
|
3803
|
-
phases?: Array<{
|
|
3804
|
-
id: { ... }
|
|
3805
|
-
name: { ... }
|
|
3806
|
-
due_date?: { ... }
|
|
3807
|
-
due_date_config?: { ... }
|
|
3808
|
-
assigned_to?: { ... }
|
|
3809
|
-
taxonomies?: { ... }
|
|
3810
|
-
}>
|
|
3811
|
-
tasks: Array<{
|
|
3812
|
-
id: { ... }
|
|
3813
|
-
name: { ... }
|
|
3814
|
-
description?: { ... }
|
|
3815
|
-
journey?: { ... }
|
|
3816
|
-
due_date?: { ... }
|
|
3817
|
-
due_date_config?: { ... }
|
|
3818
|
-
requirements?: { ... }
|
|
3819
|
-
assigned_to?: { ... }
|
|
3820
|
-
ecp?: { ... }
|
|
3821
|
-
installer?: { ... }
|
|
3822
|
-
taxonomies?: { ... }
|
|
3823
|
-
phase_id?: { ... }
|
|
3824
|
-
task_type: { ... }
|
|
3825
|
-
} | {
|
|
3826
|
-
id: { ... }
|
|
3827
|
-
name: { ... }
|
|
3828
|
-
description?: { ... }
|
|
3829
|
-
journey?: { ... }
|
|
3830
|
-
due_date?: { ... }
|
|
3831
|
-
due_date_config?: { ... }
|
|
3832
|
-
requirements?: { ... }
|
|
3833
|
-
assigned_to?: { ... }
|
|
3834
|
-
ecp?: { ... }
|
|
3835
|
-
installer?: { ... }
|
|
3836
|
-
taxonomies?: { ... }
|
|
3837
|
-
phase_id?: { ... }
|
|
3838
|
-
task_type: { ... }
|
|
3839
|
-
automation_config: { ... }
|
|
3840
|
-
// ...
|
|
3841
|
-
}
|
|
3842
|
-
```
|