@epilot/sdk 2.19.13 → 2.20.1
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/app-runtime.json +1 -1
- package/definitions/app.json +251 -4
- package/definitions/journey-runtime.json +1 -1
- package/definitions/journey.json +346 -26
- package/definitions/validation-rules.json +104 -5
- 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 +8 -8
- package/dist/apis/app.d.cts +2 -2
- package/dist/apis/app.d.ts +2 -2
- package/dist/apis/app.js +2 -2
- 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 +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-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 +8 -8
- package/dist/apis/journey.d.cts +2 -2
- package/dist/apis/journey.d.ts +2 -2
- package/dist/apis/journey.js +2 -2
- 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 +6 -6
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.d.cts +2 -2
- package/dist/apis/validation-rules.d.ts +2 -2
- 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 +6 -6
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.js +1 -1
- package/dist/app-E75NP2YE.js +7 -0
- package/dist/app-EI2PFRBV.cjs +7 -0
- package/dist/{app-runtime-T63JMR4T.js → app-runtime-ISNZMZHF.js} +1 -1
- package/dist/app-runtime-VC7HGAX3.cjs +5 -0
- package/dist/{app.d-BiknhSJo.d.cts → app.d-BHpFAvPW.d.cts} +197 -17
- package/dist/{app.d-BiknhSJo.d.ts → app.d-BHpFAvPW.d.ts} +197 -17
- package/dist/chunk-HP7PHGTJ.js +14 -0
- package/dist/{chunk-YZ2YWRG7.cjs → chunk-L7RZB4SO.cjs} +5 -5
- package/dist/{chunk-HS4W3GY7.js → chunk-LWW6JFX2.js} +5 -5
- package/dist/{chunk-HPSTDQ62.cjs → chunk-N2P6RELZ.cjs} +1 -1
- package/dist/{chunk-4MILKZOO.js → chunk-QHWCHWQT.js} +1 -1
- package/dist/chunk-T5KE6FXF.cjs +14 -0
- package/dist/index.cjs +12 -12
- package/dist/index.d.cts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +3 -3
- package/dist/journey-JS7SZKNJ.js +7 -0
- package/dist/journey-N7HRM2JJ.cjs +7 -0
- package/dist/{journey-runtime-G2O5C3N2.cjs → journey-runtime-JICGEAMK.cjs} +2 -2
- package/dist/{journey-runtime-RI2LJO5S.js → journey-runtime-WGTU2NGN.js} +1 -1
- package/dist/{journey.d-B1sOeMHw.d.ts → journey.d-B0Ju_TOw.d.cts} +778 -37
- package/dist/{journey.d-B1sOeMHw.d.cts → journey.d-B0Ju_TOw.d.ts} +778 -37
- package/dist/validation-rules-ETOO45CW.js +7 -0
- package/dist/validation-rules-MZZ7YMJM.cjs +7 -0
- package/dist/{validation-rules.d-CvGvBnMX.d.ts → validation-rules.d-D8X9MYTc.d.cts} +171 -20
- package/dist/{validation-rules.d-CvGvBnMX.d.cts → validation-rules.d-D8X9MYTc.d.ts} +171 -20
- package/docs/app.md +188 -12
- package/docs/journey.md +296 -100
- package/docs/validation-rules.md +277 -20
- package/package.json +1 -1
- package/dist/app-SJ7ITIY6.cjs +0 -7
- package/dist/app-WUPPTHZA.js +0 -7
- package/dist/app-runtime-2MEGUF3G.cjs +0 -5
- package/dist/chunk-JOUTFBLN.js +0 -14
- package/dist/chunk-LAWKCWVU.cjs +0 -14
- package/dist/journey-LHVSSVTG.cjs +0 -7
- package/dist/journey-NXL264XW.js +0 -7
- package/dist/validation-rules-B2KQKMLO.js +0 -7
- package/dist/validation-rules-GR2IVLGJ.cjs +0 -7
package/docs/journey.md
CHANGED
|
@@ -28,6 +28,7 @@ const { data } = await journeyClient.getJourneysByOrgId(...)
|
|
|
28
28
|
- [`getJourneysByOrgId`](#getjourneysbyorgid)
|
|
29
29
|
- [`getJourney`](#getjourney)
|
|
30
30
|
- [`removeJourney`](#removejourney)
|
|
31
|
+
- [`getJourneyEnvironment`](#getjourneyenvironment)
|
|
31
32
|
- [`getJourneyProducts`](#getjourneyproducts)
|
|
32
33
|
- [`createJourney`](#createjourney)
|
|
33
34
|
- [`updateJourney`](#updatejourney)
|
|
@@ -45,6 +46,9 @@ const { data } = await journeyClient.getJourneysByOrgId(...)
|
|
|
45
46
|
- [`removeJourneyV2`](#removejourneyv2)
|
|
46
47
|
|
|
47
48
|
**Schemas**
|
|
49
|
+
- [`EnvironmentMapEntry`](#environmentmapentry)
|
|
50
|
+
- [`EnvironmentMap`](#environmentmap)
|
|
51
|
+
- [`JourneyEnvironmentResponse`](#journeyenvironmentresponse)
|
|
48
52
|
- [`GetJourneysResponse`](#getjourneysresponse)
|
|
49
53
|
- [`JourneyResponse`](#journeyresponse)
|
|
50
54
|
- [`JourneyProductsResponse`](#journeyproductsresponse)
|
|
@@ -54,6 +58,7 @@ const { data } = await journeyClient.getJourneysByOrgId(...)
|
|
|
54
58
|
- [`SearchJourneysQueryRequest`](#searchjourneysqueryrequest)
|
|
55
59
|
- [`SearchJourneysResponse`](#searchjourneysresponse)
|
|
56
60
|
- [`Journey`](#journey)
|
|
61
|
+
- [`JourneyActivationGuarantee`](#journeyactivationguarantee)
|
|
57
62
|
- [`JourneyFeatureFlags`](#journeyfeatureflags)
|
|
58
63
|
- [`JourneyAuditInfo`](#journeyauditinfo)
|
|
59
64
|
- [`JourneyValidationResponse`](#journeyvalidationresponse)
|
|
@@ -123,6 +128,7 @@ const { data } = await client.getJourney({
|
|
|
123
128
|
"showStepSubtitle": true,
|
|
124
129
|
"showStepper": true,
|
|
125
130
|
"showStepperLabels": true,
|
|
131
|
+
"stepperType": "numbers",
|
|
126
132
|
"hideNextButton": true,
|
|
127
133
|
"name": "string",
|
|
128
134
|
"stepId": "string",
|
|
@@ -158,7 +164,8 @@ const { data } = await client.getJourney({
|
|
|
158
164
|
"type": "string",
|
|
159
165
|
"paramKey": "string",
|
|
160
166
|
"isRequired": true,
|
|
161
|
-
"shouldLoadEntity": true
|
|
167
|
+
"shouldLoadEntity": true,
|
|
168
|
+
"description": "string"
|
|
162
169
|
}
|
|
163
170
|
],
|
|
164
171
|
"journey_type": "Sales template (Premium)",
|
|
@@ -179,6 +186,7 @@ const { data } = await client.getJourney({
|
|
|
179
186
|
"templateId": "string",
|
|
180
187
|
"entityId": "string",
|
|
181
188
|
"mappingsAutomationId": "string",
|
|
189
|
+
"newMappings": true,
|
|
182
190
|
"targetedCustomer": "string",
|
|
183
191
|
"description": "string",
|
|
184
192
|
"organizationSettings": {},
|
|
@@ -196,20 +204,24 @@ const { data } = await client.getJourney({
|
|
|
196
204
|
"useAustrianLabels": true,
|
|
197
205
|
"enableDarkMode": true,
|
|
198
206
|
"accessMode": "PUBLIC",
|
|
207
|
+
"authGate": {
|
|
208
|
+
"stepId": "string"
|
|
209
|
+
},
|
|
199
210
|
"isPublished": true,
|
|
200
211
|
"status": "string",
|
|
201
212
|
"isActive": true,
|
|
202
213
|
"savingProgress": {
|
|
203
|
-
"
|
|
204
|
-
"
|
|
214
|
+
"mode": "auto",
|
|
215
|
+
"supportedRevision": 0
|
|
205
216
|
},
|
|
206
217
|
"thirdPartyCookies": true
|
|
207
218
|
},
|
|
208
219
|
"validationRules": {
|
|
209
220
|
"block1": "rule123",
|
|
210
|
-
"block2":
|
|
211
|
-
|
|
212
|
-
"
|
|
221
|
+
"block2": ["rule456", "rule789"],
|
|
222
|
+
"block3": {
|
|
223
|
+
"field1": "rule101",
|
|
224
|
+
"field2": ["rule102", "rule103"]
|
|
213
225
|
}
|
|
214
226
|
},
|
|
215
227
|
"_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
|
|
@@ -243,6 +255,43 @@ const { data } = await client.removeJourney({
|
|
|
243
255
|
|
|
244
256
|
---
|
|
245
257
|
|
|
258
|
+
### `getJourneyEnvironment`
|
|
259
|
+
|
|
260
|
+
Resolve the environment variables referenced by this journey. Only browser-safe value types are returned.
|
|
261
|
+
|
|
262
|
+
`GET /v1/journey/configuration/{id}/environment`
|
|
263
|
+
|
|
264
|
+
```ts
|
|
265
|
+
const { data } = await client.getJourneyEnvironment({
|
|
266
|
+
id: '123e4567-e89b-12d3-a456-426614174000',
|
|
267
|
+
})
|
|
268
|
+
```
|
|
269
|
+
|
|
270
|
+
<details>
|
|
271
|
+
<summary>Response</summary>
|
|
272
|
+
|
|
273
|
+
```json
|
|
274
|
+
{
|
|
275
|
+
"items": [
|
|
276
|
+
{
|
|
277
|
+
"datasourceId": "string",
|
|
278
|
+
"type": "Text",
|
|
279
|
+
"value": "string"
|
|
280
|
+
}
|
|
281
|
+
],
|
|
282
|
+
"errors": [
|
|
283
|
+
{
|
|
284
|
+
"datasourceId": "string",
|
|
285
|
+
"code": "not_found"
|
|
286
|
+
}
|
|
287
|
+
]
|
|
288
|
+
}
|
|
289
|
+
```
|
|
290
|
+
|
|
291
|
+
</details>
|
|
292
|
+
|
|
293
|
+
---
|
|
294
|
+
|
|
246
295
|
### `getJourneyProducts`
|
|
247
296
|
|
|
248
297
|
Get products available in the journey by id. requires public journey token to be passed.
|
|
@@ -317,6 +366,7 @@ const { data } = await client.createJourney(
|
|
|
317
366
|
showStepSubtitle: true,
|
|
318
367
|
showStepper: true,
|
|
319
368
|
showStepperLabels: true,
|
|
369
|
+
stepperType: 'numbers',
|
|
320
370
|
hideNextButton: true,
|
|
321
371
|
name: 'string',
|
|
322
372
|
stepId: 'string',
|
|
@@ -352,7 +402,8 @@ const { data } = await client.createJourney(
|
|
|
352
402
|
type: 'string',
|
|
353
403
|
paramKey: 'string',
|
|
354
404
|
isRequired: true,
|
|
355
|
-
shouldLoadEntity: true
|
|
405
|
+
shouldLoadEntity: true,
|
|
406
|
+
description: 'string'
|
|
356
407
|
}
|
|
357
408
|
],
|
|
358
409
|
journey_type: 'Sales template (Premium)',
|
|
@@ -373,6 +424,7 @@ const { data } = await client.createJourney(
|
|
|
373
424
|
templateId: 'string',
|
|
374
425
|
entityId: 'string',
|
|
375
426
|
mappingsAutomationId: 'string',
|
|
427
|
+
newMappings: true,
|
|
376
428
|
targetedCustomer: 'string',
|
|
377
429
|
description: 'string',
|
|
378
430
|
organizationSettings: {},
|
|
@@ -390,20 +442,24 @@ const { data } = await client.createJourney(
|
|
|
390
442
|
useAustrianLabels: true,
|
|
391
443
|
enableDarkMode: true,
|
|
392
444
|
accessMode: 'PUBLIC',
|
|
445
|
+
authGate: {
|
|
446
|
+
stepId: 'string'
|
|
447
|
+
},
|
|
393
448
|
isPublished: true,
|
|
394
449
|
status: 'string',
|
|
395
450
|
isActive: true,
|
|
396
451
|
savingProgress: {
|
|
397
|
-
|
|
398
|
-
|
|
452
|
+
mode: 'auto',
|
|
453
|
+
supportedRevision: 0
|
|
399
454
|
},
|
|
400
455
|
thirdPartyCookies: true
|
|
401
456
|
},
|
|
402
457
|
validationRules: {
|
|
403
458
|
block1: 'rule123',
|
|
404
|
-
block2:
|
|
405
|
-
|
|
406
|
-
|
|
459
|
+
block2: ['rule456', 'rule789'],
|
|
460
|
+
block3: {
|
|
461
|
+
field1: 'rule101',
|
|
462
|
+
field2: ['rule102', 'rule103']
|
|
407
463
|
}
|
|
408
464
|
},
|
|
409
465
|
_manifest: ['123e4567-e89b-12d3-a456-426614174000'],
|
|
@@ -431,6 +487,7 @@ const { data } = await client.createJourney(
|
|
|
431
487
|
"showStepSubtitle": true,
|
|
432
488
|
"showStepper": true,
|
|
433
489
|
"showStepperLabels": true,
|
|
490
|
+
"stepperType": "numbers",
|
|
434
491
|
"hideNextButton": true,
|
|
435
492
|
"name": "string",
|
|
436
493
|
"stepId": "string",
|
|
@@ -466,7 +523,8 @@ const { data } = await client.createJourney(
|
|
|
466
523
|
"type": "string",
|
|
467
524
|
"paramKey": "string",
|
|
468
525
|
"isRequired": true,
|
|
469
|
-
"shouldLoadEntity": true
|
|
526
|
+
"shouldLoadEntity": true,
|
|
527
|
+
"description": "string"
|
|
470
528
|
}
|
|
471
529
|
],
|
|
472
530
|
"journey_type": "Sales template (Premium)",
|
|
@@ -487,6 +545,7 @@ const { data } = await client.createJourney(
|
|
|
487
545
|
"templateId": "string",
|
|
488
546
|
"entityId": "string",
|
|
489
547
|
"mappingsAutomationId": "string",
|
|
548
|
+
"newMappings": true,
|
|
490
549
|
"targetedCustomer": "string",
|
|
491
550
|
"description": "string",
|
|
492
551
|
"organizationSettings": {},
|
|
@@ -504,20 +563,24 @@ const { data } = await client.createJourney(
|
|
|
504
563
|
"useAustrianLabels": true,
|
|
505
564
|
"enableDarkMode": true,
|
|
506
565
|
"accessMode": "PUBLIC",
|
|
566
|
+
"authGate": {
|
|
567
|
+
"stepId": "string"
|
|
568
|
+
},
|
|
507
569
|
"isPublished": true,
|
|
508
570
|
"status": "string",
|
|
509
571
|
"isActive": true,
|
|
510
572
|
"savingProgress": {
|
|
511
|
-
"
|
|
512
|
-
"
|
|
573
|
+
"mode": "auto",
|
|
574
|
+
"supportedRevision": 0
|
|
513
575
|
},
|
|
514
576
|
"thirdPartyCookies": true
|
|
515
577
|
},
|
|
516
578
|
"validationRules": {
|
|
517
579
|
"block1": "rule123",
|
|
518
|
-
"block2":
|
|
519
|
-
|
|
520
|
-
"
|
|
580
|
+
"block2": ["rule456", "rule789"],
|
|
581
|
+
"block3": {
|
|
582
|
+
"field1": "rule101",
|
|
583
|
+
"field2": ["rule102", "rule103"]
|
|
521
584
|
}
|
|
522
585
|
},
|
|
523
586
|
"_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
|
|
@@ -559,6 +622,7 @@ const { data } = await client.updateJourney(
|
|
|
559
622
|
showStepSubtitle: true,
|
|
560
623
|
showStepper: true,
|
|
561
624
|
showStepperLabels: true,
|
|
625
|
+
stepperType: 'numbers',
|
|
562
626
|
hideNextButton: true,
|
|
563
627
|
name: 'string',
|
|
564
628
|
stepId: 'string',
|
|
@@ -594,7 +658,8 @@ const { data } = await client.updateJourney(
|
|
|
594
658
|
type: 'string',
|
|
595
659
|
paramKey: 'string',
|
|
596
660
|
isRequired: true,
|
|
597
|
-
shouldLoadEntity: true
|
|
661
|
+
shouldLoadEntity: true,
|
|
662
|
+
description: 'string'
|
|
598
663
|
}
|
|
599
664
|
],
|
|
600
665
|
journey_type: 'Sales template (Premium)',
|
|
@@ -615,6 +680,7 @@ const { data } = await client.updateJourney(
|
|
|
615
680
|
templateId: 'string',
|
|
616
681
|
entityId: 'string',
|
|
617
682
|
mappingsAutomationId: 'string',
|
|
683
|
+
newMappings: true,
|
|
618
684
|
targetedCustomer: 'string',
|
|
619
685
|
description: 'string',
|
|
620
686
|
organizationSettings: {},
|
|
@@ -632,20 +698,24 @@ const { data } = await client.updateJourney(
|
|
|
632
698
|
useAustrianLabels: true,
|
|
633
699
|
enableDarkMode: true,
|
|
634
700
|
accessMode: 'PUBLIC',
|
|
701
|
+
authGate: {
|
|
702
|
+
stepId: 'string'
|
|
703
|
+
},
|
|
635
704
|
isPublished: true,
|
|
636
705
|
status: 'string',
|
|
637
706
|
isActive: true,
|
|
638
707
|
savingProgress: {
|
|
639
|
-
|
|
640
|
-
|
|
708
|
+
mode: 'auto',
|
|
709
|
+
supportedRevision: 0
|
|
641
710
|
},
|
|
642
711
|
thirdPartyCookies: true
|
|
643
712
|
},
|
|
644
713
|
validationRules: {
|
|
645
714
|
block1: 'rule123',
|
|
646
|
-
block2:
|
|
647
|
-
|
|
648
|
-
|
|
715
|
+
block2: ['rule456', 'rule789'],
|
|
716
|
+
block3: {
|
|
717
|
+
field1: 'rule101',
|
|
718
|
+
field2: ['rule102', 'rule103']
|
|
649
719
|
}
|
|
650
720
|
},
|
|
651
721
|
_manifest: ['123e4567-e89b-12d3-a456-426614174000'],
|
|
@@ -713,6 +783,7 @@ const { data } = await client.patchUpdateJourney(
|
|
|
713
783
|
"templateId": "string",
|
|
714
784
|
"entityId": "string",
|
|
715
785
|
"mappingsAutomationId": "string",
|
|
786
|
+
"newMappings": true,
|
|
716
787
|
"targetedCustomer": "string",
|
|
717
788
|
"description": "string",
|
|
718
789
|
"organizationSettings": {},
|
|
@@ -730,6 +801,7 @@ const { data } = await client.patchUpdateJourney(
|
|
|
730
801
|
"useAustrianLabels": true,
|
|
731
802
|
"enableDarkMode": true,
|
|
732
803
|
"accessMode": "PUBLIC",
|
|
804
|
+
"authGate": {},
|
|
733
805
|
"isPublished": true,
|
|
734
806
|
"status": "string",
|
|
735
807
|
"isActive": true,
|
|
@@ -738,7 +810,8 @@ const { data } = await client.patchUpdateJourney(
|
|
|
738
810
|
},
|
|
739
811
|
"validationRules": {
|
|
740
812
|
"block1": "rule123",
|
|
741
|
-
"block2":
|
|
813
|
+
"block2": ["rule456", "rule789"],
|
|
814
|
+
"block3": {}
|
|
742
815
|
},
|
|
743
816
|
"_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
|
|
744
817
|
"createdBy": "string",
|
|
@@ -825,6 +898,7 @@ const { data } = await client.generateDocument(
|
|
|
825
898
|
context_data: {
|
|
826
899
|
additionalProperties: 'string'
|
|
827
900
|
},
|
|
901
|
+
context_entity_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
|
|
828
902
|
language: 'de'
|
|
829
903
|
},
|
|
830
904
|
)
|
|
@@ -905,6 +979,7 @@ const { data } = await client.createJourneyV2(
|
|
|
905
979
|
showStepSubtitle: true,
|
|
906
980
|
showStepper: true,
|
|
907
981
|
showStepperLabels: true,
|
|
982
|
+
stepperType: 'numbers',
|
|
908
983
|
hideNextButton: true,
|
|
909
984
|
name: 'string',
|
|
910
985
|
stepId: 'string',
|
|
@@ -940,7 +1015,8 @@ const { data } = await client.createJourneyV2(
|
|
|
940
1015
|
type: 'string',
|
|
941
1016
|
paramKey: 'string',
|
|
942
1017
|
isRequired: true,
|
|
943
|
-
shouldLoadEntity: true
|
|
1018
|
+
shouldLoadEntity: true,
|
|
1019
|
+
description: 'string'
|
|
944
1020
|
}
|
|
945
1021
|
],
|
|
946
1022
|
journey_type: 'Sales template (Premium)',
|
|
@@ -953,15 +1029,13 @@ const { data } = await client.createJourneyV2(
|
|
|
953
1029
|
width: 'string',
|
|
954
1030
|
topBar: true,
|
|
955
1031
|
scrollToTop: true,
|
|
956
|
-
button: {
|
|
957
|
-
text: 'string',
|
|
958
|
-
align: 'left'
|
|
959
|
-
}
|
|
1032
|
+
button: { /* ... */ }
|
|
960
1033
|
},
|
|
961
1034
|
safeModeAutomation: true,
|
|
962
1035
|
designId: 'string',
|
|
963
1036
|
entityId: 'string',
|
|
964
1037
|
mappingsAutomationId: 'string',
|
|
1038
|
+
newMappings: true,
|
|
965
1039
|
templateId: 'string',
|
|
966
1040
|
targetedCustomer: 'string',
|
|
967
1041
|
description: 'string',
|
|
@@ -978,14 +1052,23 @@ const { data } = await client.createJourneyV2(
|
|
|
978
1052
|
useNewDesign: true,
|
|
979
1053
|
thirdPartyCookies: true,
|
|
980
1054
|
accessMode: 'PUBLIC',
|
|
1055
|
+
authGate: {
|
|
1056
|
+
stepId: 'string'
|
|
1057
|
+
},
|
|
981
1058
|
enableDarkMode: true,
|
|
982
|
-
|
|
1059
|
+
useAustrianLabels: true,
|
|
1060
|
+
isActive: true,
|
|
1061
|
+
savingProgress: {
|
|
1062
|
+
mode: 'auto',
|
|
1063
|
+
supportedRevision: 0
|
|
1064
|
+
}
|
|
983
1065
|
},
|
|
984
1066
|
validationRules: {
|
|
985
1067
|
block1: 'rule123',
|
|
986
|
-
block2:
|
|
987
|
-
|
|
988
|
-
|
|
1068
|
+
block2: ['rule456', 'rule789'],
|
|
1069
|
+
block3: {
|
|
1070
|
+
field1: 'rule101',
|
|
1071
|
+
field2: ['rule102', 'rule103']
|
|
989
1072
|
}
|
|
990
1073
|
},
|
|
991
1074
|
_manifest: ['123e4567-e89b-12d3-a456-426614174000']
|
|
@@ -1009,6 +1092,7 @@ const { data } = await client.createJourneyV2(
|
|
|
1009
1092
|
"showStepSubtitle": true,
|
|
1010
1093
|
"showStepper": true,
|
|
1011
1094
|
"showStepperLabels": true,
|
|
1095
|
+
"stepperType": "numbers",
|
|
1012
1096
|
"hideNextButton": true,
|
|
1013
1097
|
"name": "string",
|
|
1014
1098
|
"stepId": "string",
|
|
@@ -1044,7 +1128,8 @@ const { data } = await client.createJourneyV2(
|
|
|
1044
1128
|
"type": "string",
|
|
1045
1129
|
"paramKey": "string",
|
|
1046
1130
|
"isRequired": true,
|
|
1047
|
-
"shouldLoadEntity": true
|
|
1131
|
+
"shouldLoadEntity": true,
|
|
1132
|
+
"description": "string"
|
|
1048
1133
|
}
|
|
1049
1134
|
],
|
|
1050
1135
|
"journey_type": "Sales template (Premium)",
|
|
@@ -1057,15 +1142,13 @@ const { data } = await client.createJourneyV2(
|
|
|
1057
1142
|
"width": "string",
|
|
1058
1143
|
"topBar": true,
|
|
1059
1144
|
"scrollToTop": true,
|
|
1060
|
-
"button": {
|
|
1061
|
-
"text": "string",
|
|
1062
|
-
"align": "left"
|
|
1063
|
-
}
|
|
1145
|
+
"button": {}
|
|
1064
1146
|
},
|
|
1065
1147
|
"safeModeAutomation": true,
|
|
1066
1148
|
"designId": "string",
|
|
1067
1149
|
"entityId": "string",
|
|
1068
1150
|
"mappingsAutomationId": "string",
|
|
1151
|
+
"newMappings": true,
|
|
1069
1152
|
"templateId": "string",
|
|
1070
1153
|
"targetedCustomer": "string",
|
|
1071
1154
|
"description": "string",
|
|
@@ -1082,14 +1165,23 @@ const { data } = await client.createJourneyV2(
|
|
|
1082
1165
|
"useNewDesign": true,
|
|
1083
1166
|
"thirdPartyCookies": true,
|
|
1084
1167
|
"accessMode": "PUBLIC",
|
|
1168
|
+
"authGate": {
|
|
1169
|
+
"stepId": "string"
|
|
1170
|
+
},
|
|
1085
1171
|
"enableDarkMode": true,
|
|
1086
|
-
"
|
|
1172
|
+
"useAustrianLabels": true,
|
|
1173
|
+
"isActive": true,
|
|
1174
|
+
"savingProgress": {
|
|
1175
|
+
"mode": "auto",
|
|
1176
|
+
"supportedRevision": 0
|
|
1177
|
+
}
|
|
1087
1178
|
},
|
|
1088
1179
|
"validationRules": {
|
|
1089
1180
|
"block1": "rule123",
|
|
1090
|
-
"block2":
|
|
1091
|
-
|
|
1092
|
-
"
|
|
1181
|
+
"block2": ["rule456", "rule789"],
|
|
1182
|
+
"block3": {
|
|
1183
|
+
"field1": "rule101",
|
|
1184
|
+
"field2": ["rule102", "rule103"]
|
|
1093
1185
|
}
|
|
1094
1186
|
},
|
|
1095
1187
|
"_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
|
|
@@ -1121,6 +1213,7 @@ const { data } = await client.updateJourneyV2(
|
|
|
1121
1213
|
showStepSubtitle: true,
|
|
1122
1214
|
showStepper: true,
|
|
1123
1215
|
showStepperLabels: true,
|
|
1216
|
+
stepperType: 'numbers',
|
|
1124
1217
|
hideNextButton: true,
|
|
1125
1218
|
name: 'string',
|
|
1126
1219
|
stepId: 'string',
|
|
@@ -1156,7 +1249,8 @@ const { data } = await client.updateJourneyV2(
|
|
|
1156
1249
|
type: 'string',
|
|
1157
1250
|
paramKey: 'string',
|
|
1158
1251
|
isRequired: true,
|
|
1159
|
-
shouldLoadEntity: true
|
|
1252
|
+
shouldLoadEntity: true,
|
|
1253
|
+
description: 'string'
|
|
1160
1254
|
}
|
|
1161
1255
|
],
|
|
1162
1256
|
journey_type: 'Sales template (Premium)',
|
|
@@ -1169,15 +1263,13 @@ const { data } = await client.updateJourneyV2(
|
|
|
1169
1263
|
width: 'string',
|
|
1170
1264
|
topBar: true,
|
|
1171
1265
|
scrollToTop: true,
|
|
1172
|
-
button: {
|
|
1173
|
-
text: 'string',
|
|
1174
|
-
align: 'left'
|
|
1175
|
-
}
|
|
1266
|
+
button: { /* ... */ }
|
|
1176
1267
|
},
|
|
1177
1268
|
safeModeAutomation: true,
|
|
1178
1269
|
designId: 'string',
|
|
1179
1270
|
entityId: 'string',
|
|
1180
1271
|
mappingsAutomationId: 'string',
|
|
1272
|
+
newMappings: true,
|
|
1181
1273
|
templateId: 'string',
|
|
1182
1274
|
targetedCustomer: 'string',
|
|
1183
1275
|
description: 'string',
|
|
@@ -1194,14 +1286,23 @@ const { data } = await client.updateJourneyV2(
|
|
|
1194
1286
|
useNewDesign: true,
|
|
1195
1287
|
thirdPartyCookies: true,
|
|
1196
1288
|
accessMode: 'PUBLIC',
|
|
1289
|
+
authGate: {
|
|
1290
|
+
stepId: 'string'
|
|
1291
|
+
},
|
|
1197
1292
|
enableDarkMode: true,
|
|
1198
|
-
|
|
1293
|
+
useAustrianLabels: true,
|
|
1294
|
+
isActive: true,
|
|
1295
|
+
savingProgress: {
|
|
1296
|
+
mode: 'auto',
|
|
1297
|
+
supportedRevision: 0
|
|
1298
|
+
}
|
|
1199
1299
|
},
|
|
1200
1300
|
validationRules: {
|
|
1201
1301
|
block1: 'rule123',
|
|
1202
|
-
block2:
|
|
1203
|
-
|
|
1204
|
-
|
|
1302
|
+
block2: ['rule456', 'rule789'],
|
|
1303
|
+
block3: {
|
|
1304
|
+
field1: 'rule101',
|
|
1305
|
+
field2: ['rule102', 'rule103']
|
|
1205
1306
|
}
|
|
1206
1307
|
},
|
|
1207
1308
|
_manifest: ['123e4567-e89b-12d3-a456-426614174000']
|
|
@@ -1225,6 +1326,7 @@ const { data } = await client.updateJourneyV2(
|
|
|
1225
1326
|
"showStepSubtitle": true,
|
|
1226
1327
|
"showStepper": true,
|
|
1227
1328
|
"showStepperLabels": true,
|
|
1329
|
+
"stepperType": "numbers",
|
|
1228
1330
|
"hideNextButton": true,
|
|
1229
1331
|
"name": "string",
|
|
1230
1332
|
"stepId": "string",
|
|
@@ -1260,7 +1362,8 @@ const { data } = await client.updateJourneyV2(
|
|
|
1260
1362
|
"type": "string",
|
|
1261
1363
|
"paramKey": "string",
|
|
1262
1364
|
"isRequired": true,
|
|
1263
|
-
"shouldLoadEntity": true
|
|
1365
|
+
"shouldLoadEntity": true,
|
|
1366
|
+
"description": "string"
|
|
1264
1367
|
}
|
|
1265
1368
|
],
|
|
1266
1369
|
"journey_type": "Sales template (Premium)",
|
|
@@ -1273,15 +1376,13 @@ const { data } = await client.updateJourneyV2(
|
|
|
1273
1376
|
"width": "string",
|
|
1274
1377
|
"topBar": true,
|
|
1275
1378
|
"scrollToTop": true,
|
|
1276
|
-
"button": {
|
|
1277
|
-
"text": "string",
|
|
1278
|
-
"align": "left"
|
|
1279
|
-
}
|
|
1379
|
+
"button": {}
|
|
1280
1380
|
},
|
|
1281
1381
|
"safeModeAutomation": true,
|
|
1282
1382
|
"designId": "string",
|
|
1283
1383
|
"entityId": "string",
|
|
1284
1384
|
"mappingsAutomationId": "string",
|
|
1385
|
+
"newMappings": true,
|
|
1285
1386
|
"templateId": "string",
|
|
1286
1387
|
"targetedCustomer": "string",
|
|
1287
1388
|
"description": "string",
|
|
@@ -1298,14 +1399,23 @@ const { data } = await client.updateJourneyV2(
|
|
|
1298
1399
|
"useNewDesign": true,
|
|
1299
1400
|
"thirdPartyCookies": true,
|
|
1300
1401
|
"accessMode": "PUBLIC",
|
|
1402
|
+
"authGate": {
|
|
1403
|
+
"stepId": "string"
|
|
1404
|
+
},
|
|
1301
1405
|
"enableDarkMode": true,
|
|
1302
|
-
"
|
|
1406
|
+
"useAustrianLabels": true,
|
|
1407
|
+
"isActive": true,
|
|
1408
|
+
"savingProgress": {
|
|
1409
|
+
"mode": "auto",
|
|
1410
|
+
"supportedRevision": 0
|
|
1411
|
+
}
|
|
1303
1412
|
},
|
|
1304
1413
|
"validationRules": {
|
|
1305
1414
|
"block1": "rule123",
|
|
1306
|
-
"block2":
|
|
1307
|
-
|
|
1308
|
-
"
|
|
1415
|
+
"block2": ["rule456", "rule789"],
|
|
1416
|
+
"block3": {
|
|
1417
|
+
"field1": "rule101",
|
|
1418
|
+
"field2": ["rule102", "rule103"]
|
|
1309
1419
|
}
|
|
1310
1420
|
},
|
|
1311
1421
|
"_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
|
|
@@ -1348,6 +1458,7 @@ const { data } = await client.patchUpdateJourneyV2(
|
|
|
1348
1458
|
"showStepSubtitle": true,
|
|
1349
1459
|
"showStepper": true,
|
|
1350
1460
|
"showStepperLabels": true,
|
|
1461
|
+
"stepperType": "numbers",
|
|
1351
1462
|
"hideNextButton": true,
|
|
1352
1463
|
"name": "string",
|
|
1353
1464
|
"stepId": "string",
|
|
@@ -1383,7 +1494,8 @@ const { data } = await client.patchUpdateJourneyV2(
|
|
|
1383
1494
|
"type": "string",
|
|
1384
1495
|
"paramKey": "string",
|
|
1385
1496
|
"isRequired": true,
|
|
1386
|
-
"shouldLoadEntity": true
|
|
1497
|
+
"shouldLoadEntity": true,
|
|
1498
|
+
"description": "string"
|
|
1387
1499
|
}
|
|
1388
1500
|
],
|
|
1389
1501
|
"journey_type": "Sales template (Premium)",
|
|
@@ -1396,15 +1508,13 @@ const { data } = await client.patchUpdateJourneyV2(
|
|
|
1396
1508
|
"width": "string",
|
|
1397
1509
|
"topBar": true,
|
|
1398
1510
|
"scrollToTop": true,
|
|
1399
|
-
"button": {
|
|
1400
|
-
"text": "string",
|
|
1401
|
-
"align": "left"
|
|
1402
|
-
}
|
|
1511
|
+
"button": {}
|
|
1403
1512
|
},
|
|
1404
1513
|
"safeModeAutomation": true,
|
|
1405
1514
|
"designId": "string",
|
|
1406
1515
|
"entityId": "string",
|
|
1407
1516
|
"mappingsAutomationId": "string",
|
|
1517
|
+
"newMappings": true,
|
|
1408
1518
|
"templateId": "string",
|
|
1409
1519
|
"targetedCustomer": "string",
|
|
1410
1520
|
"description": "string",
|
|
@@ -1421,14 +1531,23 @@ const { data } = await client.patchUpdateJourneyV2(
|
|
|
1421
1531
|
"useNewDesign": true,
|
|
1422
1532
|
"thirdPartyCookies": true,
|
|
1423
1533
|
"accessMode": "PUBLIC",
|
|
1534
|
+
"authGate": {
|
|
1535
|
+
"stepId": "string"
|
|
1536
|
+
},
|
|
1424
1537
|
"enableDarkMode": true,
|
|
1425
|
-
"
|
|
1538
|
+
"useAustrianLabels": true,
|
|
1539
|
+
"isActive": true,
|
|
1540
|
+
"savingProgress": {
|
|
1541
|
+
"mode": "auto",
|
|
1542
|
+
"supportedRevision": 0
|
|
1543
|
+
}
|
|
1426
1544
|
},
|
|
1427
1545
|
"validationRules": {
|
|
1428
1546
|
"block1": "rule123",
|
|
1429
|
-
"block2":
|
|
1430
|
-
|
|
1431
|
-
"
|
|
1547
|
+
"block2": ["rule456", "rule789"],
|
|
1548
|
+
"block3": {
|
|
1549
|
+
"field1": "rule101",
|
|
1550
|
+
"field2": ["rule102", "rule103"]
|
|
1432
1551
|
}
|
|
1433
1552
|
},
|
|
1434
1553
|
"_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
|
|
@@ -1468,6 +1587,7 @@ const { data } = await client.getJourneyV2({
|
|
|
1468
1587
|
"showStepSubtitle": true,
|
|
1469
1588
|
"showStepper": true,
|
|
1470
1589
|
"showStepperLabels": true,
|
|
1590
|
+
"stepperType": "numbers",
|
|
1471
1591
|
"hideNextButton": true,
|
|
1472
1592
|
"name": "string",
|
|
1473
1593
|
"stepId": "string",
|
|
@@ -1503,7 +1623,8 @@ const { data } = await client.getJourneyV2({
|
|
|
1503
1623
|
"type": "string",
|
|
1504
1624
|
"paramKey": "string",
|
|
1505
1625
|
"isRequired": true,
|
|
1506
|
-
"shouldLoadEntity": true
|
|
1626
|
+
"shouldLoadEntity": true,
|
|
1627
|
+
"description": "string"
|
|
1507
1628
|
}
|
|
1508
1629
|
],
|
|
1509
1630
|
"journey_type": "Sales template (Premium)",
|
|
@@ -1516,15 +1637,13 @@ const { data } = await client.getJourneyV2({
|
|
|
1516
1637
|
"width": "string",
|
|
1517
1638
|
"topBar": true,
|
|
1518
1639
|
"scrollToTop": true,
|
|
1519
|
-
"button": {
|
|
1520
|
-
"text": "string",
|
|
1521
|
-
"align": "left"
|
|
1522
|
-
}
|
|
1640
|
+
"button": {}
|
|
1523
1641
|
},
|
|
1524
1642
|
"safeModeAutomation": true,
|
|
1525
1643
|
"designId": "string",
|
|
1526
1644
|
"entityId": "string",
|
|
1527
1645
|
"mappingsAutomationId": "string",
|
|
1646
|
+
"newMappings": true,
|
|
1528
1647
|
"templateId": "string",
|
|
1529
1648
|
"targetedCustomer": "string",
|
|
1530
1649
|
"description": "string",
|
|
@@ -1541,14 +1660,23 @@ const { data } = await client.getJourneyV2({
|
|
|
1541
1660
|
"useNewDesign": true,
|
|
1542
1661
|
"thirdPartyCookies": true,
|
|
1543
1662
|
"accessMode": "PUBLIC",
|
|
1663
|
+
"authGate": {
|
|
1664
|
+
"stepId": "string"
|
|
1665
|
+
},
|
|
1544
1666
|
"enableDarkMode": true,
|
|
1545
|
-
"
|
|
1667
|
+
"useAustrianLabels": true,
|
|
1668
|
+
"isActive": true,
|
|
1669
|
+
"savingProgress": {
|
|
1670
|
+
"mode": "auto",
|
|
1671
|
+
"supportedRevision": 0
|
|
1672
|
+
}
|
|
1546
1673
|
},
|
|
1547
1674
|
"validationRules": {
|
|
1548
1675
|
"block1": "rule123",
|
|
1549
|
-
"block2":
|
|
1550
|
-
|
|
1551
|
-
"
|
|
1676
|
+
"block2": ["rule456", "rule789"],
|
|
1677
|
+
"block3": {
|
|
1678
|
+
"field1": "rule101",
|
|
1679
|
+
"field2": ["rule102", "rule103"]
|
|
1552
1680
|
}
|
|
1553
1681
|
},
|
|
1554
1682
|
"_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
|
|
@@ -1630,6 +1758,46 @@ const { data } = await client.getButtonOptions({
|
|
|
1630
1758
|
|
|
1631
1759
|
## Schemas
|
|
1632
1760
|
|
|
1761
|
+
### `EnvironmentMapEntry`
|
|
1762
|
+
|
|
1763
|
+
```ts
|
|
1764
|
+
type EnvironmentMapEntry = {
|
|
1765
|
+
key: string
|
|
1766
|
+
value: string | Record<string, string>
|
|
1767
|
+
}
|
|
1768
|
+
```
|
|
1769
|
+
|
|
1770
|
+
### `EnvironmentMap`
|
|
1771
|
+
|
|
1772
|
+
```ts
|
|
1773
|
+
type EnvironmentMap = {
|
|
1774
|
+
fallbackLanguage?: string
|
|
1775
|
+
options: Array<{
|
|
1776
|
+
key: string
|
|
1777
|
+
value: string | Record<string, string>
|
|
1778
|
+
}>
|
|
1779
|
+
}
|
|
1780
|
+
```
|
|
1781
|
+
|
|
1782
|
+
### `JourneyEnvironmentResponse`
|
|
1783
|
+
|
|
1784
|
+
```ts
|
|
1785
|
+
type JourneyEnvironmentResponse = {
|
|
1786
|
+
items: Array<{
|
|
1787
|
+
datasourceId: string
|
|
1788
|
+
type: "Text" | "Number" | "Boolean" | "Map"
|
|
1789
|
+
value: string | number | boolean | {
|
|
1790
|
+
fallbackLanguage?: { ... }
|
|
1791
|
+
options: { ... }
|
|
1792
|
+
}
|
|
1793
|
+
}>
|
|
1794
|
+
errors: Array<{
|
|
1795
|
+
datasourceId: string
|
|
1796
|
+
code: "not_found" | "unsupported_type" | "not_set" | "invalid_value" | "incompatible_consumer"
|
|
1797
|
+
}>
|
|
1798
|
+
}
|
|
1799
|
+
```
|
|
1800
|
+
|
|
1633
1801
|
### `GetJourneysResponse`
|
|
1634
1802
|
|
|
1635
1803
|
```ts
|
|
@@ -1652,6 +1820,7 @@ type JourneyResponse = {
|
|
|
1652
1820
|
showStepSubtitle?: { ... }
|
|
1653
1821
|
showStepper?: { ... }
|
|
1654
1822
|
showStepperLabels?: { ... }
|
|
1823
|
+
stepperType?: { ... }
|
|
1655
1824
|
hideNextButton?: { ... }
|
|
1656
1825
|
name: { ... }
|
|
1657
1826
|
stepId?: { ... }
|
|
@@ -1689,6 +1858,7 @@ type JourneyResponse = {
|
|
|
1689
1858
|
paramKey: { ... }
|
|
1690
1859
|
isRequired?: { ... }
|
|
1691
1860
|
shouldLoadEntity?: { ... }
|
|
1861
|
+
description?: { ... }
|
|
1692
1862
|
}>
|
|
1693
1863
|
journey_type?: string
|
|
1694
1864
|
protected?: boolean
|
|
@@ -1701,6 +1871,7 @@ type JourneyResponse = {
|
|
|
1701
1871
|
templateId?: { ... }
|
|
1702
1872
|
entityId?: { ... }
|
|
1703
1873
|
mappingsAutomationId?: { ... }
|
|
1874
|
+
newMappings?: { ... }
|
|
1704
1875
|
targetedCustomer?: { ... }
|
|
1705
1876
|
description?: { ... }
|
|
1706
1877
|
organizationSettings?: { ... }
|
|
@@ -1718,13 +1889,14 @@ type JourneyResponse = {
|
|
|
1718
1889
|
useAustrianLabels?: { ... }
|
|
1719
1890
|
enableDarkMode?: { ... }
|
|
1720
1891
|
accessMode?: { ... }
|
|
1892
|
+
authGate?: { ... }
|
|
1721
1893
|
isPublished?: { ... }
|
|
1722
1894
|
status?: { ... }
|
|
1723
1895
|
isActive?: { ... }
|
|
1724
1896
|
savingProgress?: { ... }
|
|
1725
1897
|
thirdPartyCookies?: { ... }
|
|
1726
1898
|
}
|
|
1727
|
-
validationRules?: Record<string, string | Record<string, string>>
|
|
1899
|
+
validationRules?: Record<string, string | string[] | Record<string, string | string[]>>
|
|
1728
1900
|
_manifest?: string // uuid[]
|
|
1729
1901
|
createdBy?: string
|
|
1730
1902
|
updatedBy?: string
|
|
@@ -1735,7 +1907,7 @@ type JourneyResponse = {
|
|
|
1735
1907
|
version: number
|
|
1736
1908
|
revisions: number
|
|
1737
1909
|
featureFlags?: Record<string, unknown>
|
|
1738
|
-
|
|
1910
|
+
// ...
|
|
1739
1911
|
}
|
|
1740
1912
|
```
|
|
1741
1913
|
|
|
@@ -1786,6 +1958,7 @@ type JourneyCreationRequest = {
|
|
|
1786
1958
|
showStepSubtitle?: boolean
|
|
1787
1959
|
showStepper?: boolean
|
|
1788
1960
|
showStepperLabels?: boolean
|
|
1961
|
+
stepperType?: "numbers" | "progress bar"
|
|
1789
1962
|
hideNextButton?: boolean
|
|
1790
1963
|
name: string
|
|
1791
1964
|
stepId?: string
|
|
@@ -1829,6 +2002,7 @@ type JourneyCreationRequest = {
|
|
|
1829
2002
|
paramKey: string
|
|
1830
2003
|
isRequired?: boolean
|
|
1831
2004
|
shouldLoadEntity?: boolean
|
|
2005
|
+
description?: string
|
|
1832
2006
|
}>
|
|
1833
2007
|
journey_type?: string
|
|
1834
2008
|
protected?: boolean
|
|
@@ -1848,6 +2022,7 @@ type JourneyCreationRequest = {
|
|
|
1848
2022
|
templateId?: string
|
|
1849
2023
|
entityId?: string
|
|
1850
2024
|
mappingsAutomationId?: string
|
|
2025
|
+
newMappings?: boolean
|
|
1851
2026
|
targetedCustomer?: string
|
|
1852
2027
|
description?: string
|
|
1853
2028
|
organizationSettings?: Record<string, boolean>
|
|
@@ -1865,15 +2040,12 @@ type JourneyCreationRequest = {
|
|
|
1865
2040
|
useAustrianLabels?: boolean
|
|
1866
2041
|
enableDarkMode?: boolean
|
|
1867
2042
|
accessMode?: "PUBLIC" | "PRIVATE"
|
|
2043
|
+
authGate?: {
|
|
2044
|
+
stepId: { ... }
|
|
2045
|
+
}
|
|
1868
2046
|
isPublished?: boolean
|
|
1869
2047
|
status?: string
|
|
1870
2048
|
isActive?: boolean
|
|
1871
|
-
savingProgress?: {
|
|
1872
|
-
savingMode?: { ... }
|
|
1873
|
-
supportedVersion?: { ... }
|
|
1874
|
-
}
|
|
1875
|
-
thirdPartyCookies?: boolean
|
|
1876
|
-
}
|
|
1877
2049
|
// ...
|
|
1878
2050
|
}
|
|
1879
2051
|
```
|
|
@@ -1892,6 +2064,7 @@ type JourneyCreationRequestV2 = {
|
|
|
1892
2064
|
showStepSubtitle?: boolean
|
|
1893
2065
|
showStepper?: boolean
|
|
1894
2066
|
showStepperLabels?: boolean
|
|
2067
|
+
stepperType?: "numbers" | "progress bar"
|
|
1895
2068
|
hideNextButton?: boolean
|
|
1896
2069
|
name: string
|
|
1897
2070
|
stepId?: string
|
|
@@ -1935,6 +2108,7 @@ type JourneyCreationRequestV2 = {
|
|
|
1935
2108
|
paramKey: string
|
|
1936
2109
|
isRequired?: boolean
|
|
1937
2110
|
shouldLoadEntity?: boolean
|
|
2111
|
+
description?: string
|
|
1938
2112
|
}>
|
|
1939
2113
|
journey_type?: string
|
|
1940
2114
|
protected?: boolean
|
|
@@ -1952,6 +2126,7 @@ type JourneyCreationRequestV2 = {
|
|
|
1952
2126
|
designId?: string
|
|
1953
2127
|
entityId?: string
|
|
1954
2128
|
mappingsAutomationId?: string
|
|
2129
|
+
newMappings?: boolean
|
|
1955
2130
|
templateId?: string
|
|
1956
2131
|
targetedCustomer?: string
|
|
1957
2132
|
description?: string
|
|
@@ -1968,11 +2143,17 @@ type JourneyCreationRequestV2 = {
|
|
|
1968
2143
|
useNewDesign?: boolean
|
|
1969
2144
|
thirdPartyCookies?: boolean
|
|
1970
2145
|
accessMode?: "PUBLIC" | "PRIVATE"
|
|
2146
|
+
authGate?: {
|
|
2147
|
+
stepId: { ... }
|
|
2148
|
+
}
|
|
1971
2149
|
enableDarkMode?: boolean
|
|
2150
|
+
useAustrianLabels?: boolean
|
|
1972
2151
|
isActive?: boolean
|
|
1973
|
-
|
|
1974
|
-
|
|
1975
|
-
|
|
2152
|
+
savingProgress?: {
|
|
2153
|
+
mode?: { ... }
|
|
2154
|
+
supportedRevision?: { ... }
|
|
2155
|
+
}
|
|
2156
|
+
// ...
|
|
1976
2157
|
}
|
|
1977
2158
|
```
|
|
1978
2159
|
|
|
@@ -2028,6 +2209,7 @@ type Journey = {
|
|
|
2028
2209
|
showStepSubtitle?: boolean
|
|
2029
2210
|
showStepper?: boolean
|
|
2030
2211
|
showStepperLabels?: boolean
|
|
2212
|
+
stepperType?: "numbers" | "progress bar"
|
|
2031
2213
|
hideNextButton?: boolean
|
|
2032
2214
|
name: string
|
|
2033
2215
|
stepId?: string
|
|
@@ -2071,6 +2253,7 @@ type Journey = {
|
|
|
2071
2253
|
paramKey: string
|
|
2072
2254
|
isRequired?: boolean
|
|
2073
2255
|
shouldLoadEntity?: boolean
|
|
2256
|
+
description?: string
|
|
2074
2257
|
}>
|
|
2075
2258
|
journey_type?: string
|
|
2076
2259
|
protected?: boolean
|
|
@@ -2090,6 +2273,7 @@ type Journey = {
|
|
|
2090
2273
|
templateId?: string
|
|
2091
2274
|
entityId?: string
|
|
2092
2275
|
mappingsAutomationId?: string
|
|
2276
|
+
newMappings?: boolean
|
|
2093
2277
|
targetedCustomer?: string
|
|
2094
2278
|
description?: string
|
|
2095
2279
|
organizationSettings?: Record<string, boolean>
|
|
@@ -2107,19 +2291,29 @@ type Journey = {
|
|
|
2107
2291
|
useAustrianLabels?: boolean
|
|
2108
2292
|
enableDarkMode?: boolean
|
|
2109
2293
|
accessMode?: "PUBLIC" | "PRIVATE"
|
|
2294
|
+
authGate?: {
|
|
2295
|
+
stepId: { ... }
|
|
2296
|
+
}
|
|
2110
2297
|
isPublished?: boolean
|
|
2111
2298
|
status?: string
|
|
2112
2299
|
isActive?: boolean
|
|
2113
|
-
savingProgress?: {
|
|
2114
|
-
savingMode?: { ... }
|
|
2115
|
-
supportedVersion?: { ... }
|
|
2116
|
-
}
|
|
2117
|
-
thirdPartyCookies?: boolean
|
|
2118
|
-
}
|
|
2119
2300
|
// ...
|
|
2120
2301
|
}
|
|
2121
2302
|
```
|
|
2122
2303
|
|
|
2304
|
+
### `JourneyActivationGuarantee`
|
|
2305
|
+
|
|
2306
|
+
Journeys read from the API always carry an explicit `settings.isActive`. The flag remains optional in request bodies.
|
|
2307
|
+
|
|
2308
|
+
|
|
2309
|
+
```ts
|
|
2310
|
+
type JourneyActivationGuarantee = {
|
|
2311
|
+
settings: {
|
|
2312
|
+
isActive: boolean
|
|
2313
|
+
}
|
|
2314
|
+
}
|
|
2315
|
+
```
|
|
2316
|
+
|
|
2123
2317
|
### `JourneyFeatureFlags`
|
|
2124
2318
|
|
|
2125
2319
|
```ts
|
|
@@ -2263,6 +2457,7 @@ type GenerateDocumentRequest = {
|
|
|
2263
2457
|
context_data: {
|
|
2264
2458
|
additionalProperties?: string
|
|
2265
2459
|
}
|
|
2460
|
+
context_entity_id?: string // uuid
|
|
2266
2461
|
language?: string
|
|
2267
2462
|
}
|
|
2268
2463
|
```
|
|
@@ -2291,19 +2486,20 @@ type ButtonOption = {
|
|
|
2291
2486
|
### `ValidationRuleRef`
|
|
2292
2487
|
|
|
2293
2488
|
References to validation rules organized by blocks and fields.
|
|
2294
|
-
Maps block IDs to either
|
|
2489
|
+
Maps block IDs to either one or more ordered rule IDs (for block-level rules)
|
|
2490
|
+
or rule references (for field-level rules).
|
|
2295
2491
|
|
|
2296
2492
|
|
|
2297
2493
|
```ts
|
|
2298
|
-
type ValidationRuleRef = Record<string, string | Record<string, string>>
|
|
2494
|
+
type ValidationRuleRef = Record<string, string | string[] | Record<string, string | string[]>>
|
|
2299
2495
|
```
|
|
2300
2496
|
|
|
2301
2497
|
### `RuleRef`
|
|
2302
2498
|
|
|
2303
2499
|
Field-level rule references within a block.
|
|
2304
|
-
Maps field names to rule IDs.
|
|
2500
|
+
Maps field names to one or more ordered rule IDs.
|
|
2305
2501
|
|
|
2306
2502
|
|
|
2307
2503
|
```ts
|
|
2308
|
-
type RuleRef = Record<string, string>
|
|
2504
|
+
type RuleRef = Record<string, string | string[]>
|
|
2309
2505
|
```
|