@epilot/sdk 2.19.13 → 2.19.14
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/journey-runtime.json +1 -1
- package/definitions/journey.json +346 -26
- 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 +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.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/{chunk-YZ2YWRG7.cjs → chunk-E4NQOOA3.cjs} +2 -2
- package/dist/{chunk-HS4W3GY7.js → chunk-G5HHIB4D.js} +2 -2
- package/dist/chunk-HP7PHGTJ.js +14 -0
- package/dist/chunk-T5KE6FXF.cjs +14 -0
- 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/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.cts → journey.d-B0Ju_TOw.d.cts} +778 -37
- package/dist/{journey.d-B1sOeMHw.d.ts → journey.d-B0Ju_TOw.d.ts} +778 -37
- package/docs/journey.md +296 -100
- package/package.json +1 -1
- 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
|
@@ -22,6 +22,16 @@ declare namespace Components {
|
|
|
22
22
|
*/
|
|
23
23
|
label?: string;
|
|
24
24
|
}
|
|
25
|
+
export interface EnvironmentMap {
|
|
26
|
+
fallbackLanguage?: string;
|
|
27
|
+
options: EnvironmentMapEntry[];
|
|
28
|
+
}
|
|
29
|
+
export interface EnvironmentMapEntry {
|
|
30
|
+
key: string;
|
|
31
|
+
value: string | {
|
|
32
|
+
[name: string]: string;
|
|
33
|
+
};
|
|
34
|
+
}
|
|
25
35
|
export interface GenerateDocumentRequest {
|
|
26
36
|
/**
|
|
27
37
|
* Entity id for the template being used
|
|
@@ -35,6 +45,10 @@ declare namespace Components {
|
|
|
35
45
|
context_data: {
|
|
36
46
|
additionalProperties?: string;
|
|
37
47
|
};
|
|
48
|
+
/**
|
|
49
|
+
* Entity id used to resolve entity and relational template variables
|
|
50
|
+
*/
|
|
51
|
+
context_entity_id?: string; // uuid
|
|
38
52
|
/**
|
|
39
53
|
* Language code for the document
|
|
40
54
|
* example:
|
|
@@ -147,6 +161,7 @@ declare namespace Components {
|
|
|
147
161
|
showStepSubtitle?: boolean | null;
|
|
148
162
|
showStepper?: boolean | null;
|
|
149
163
|
showStepperLabels?: boolean | null;
|
|
164
|
+
stepperType?: "numbers" | "progress bar";
|
|
150
165
|
hideNextButton?: boolean | null;
|
|
151
166
|
name: string;
|
|
152
167
|
stepId?: string;
|
|
@@ -259,6 +274,10 @@ declare namespace Components {
|
|
|
259
274
|
* If type is not text, we can instruct the journey to fetch the entity id we receive as value
|
|
260
275
|
*/
|
|
261
276
|
shouldLoadEntity?: boolean;
|
|
277
|
+
/**
|
|
278
|
+
* Human-readable note describing the parameter's purpose. Free text; may contain newlines.
|
|
279
|
+
*/
|
|
280
|
+
description?: string | null;
|
|
262
281
|
}[];
|
|
263
282
|
/**
|
|
264
283
|
* Journey Template
|
|
@@ -277,7 +296,11 @@ declare namespace Components {
|
|
|
277
296
|
settings?: {
|
|
278
297
|
embedOptions?: {
|
|
279
298
|
mode?: "full-screen" | "inline";
|
|
280
|
-
|
|
299
|
+
/**
|
|
300
|
+
* example:
|
|
301
|
+
* de
|
|
302
|
+
*/
|
|
303
|
+
lang?: string;
|
|
281
304
|
width?: string;
|
|
282
305
|
topBar?: boolean;
|
|
283
306
|
scrollToTop?: boolean;
|
|
@@ -292,9 +315,13 @@ declare namespace Components {
|
|
|
292
315
|
*/
|
|
293
316
|
canary?: boolean;
|
|
294
317
|
designId: string;
|
|
295
|
-
templateId?: string;
|
|
318
|
+
templateId?: string | null;
|
|
296
319
|
entityId?: string | null;
|
|
297
320
|
mappingsAutomationId?: string;
|
|
321
|
+
/**
|
|
322
|
+
* When true, the journey is created without a mapping config or automation; mappings are managed as advanced mappings on a lazily created automation.
|
|
323
|
+
*/
|
|
324
|
+
newMappings?: boolean;
|
|
298
325
|
targetedCustomer?: string;
|
|
299
326
|
description?: string | null;
|
|
300
327
|
organizationSettings?: {
|
|
@@ -338,12 +365,21 @@ declare namespace Components {
|
|
|
338
365
|
*/
|
|
339
366
|
enableDarkMode?: boolean;
|
|
340
367
|
accessMode?: "PUBLIC" | "PRIVATE";
|
|
368
|
+
/**
|
|
369
|
+
* Steps after this step require an authenticated session (auth gate)
|
|
370
|
+
*/
|
|
371
|
+
authGate?: {
|
|
372
|
+
/**
|
|
373
|
+
* The step containing the Login & Registration block
|
|
374
|
+
*/
|
|
375
|
+
stepId: string;
|
|
376
|
+
};
|
|
341
377
|
isPublished?: boolean;
|
|
342
378
|
status?: string;
|
|
343
379
|
isActive?: boolean;
|
|
344
380
|
savingProgress?: {
|
|
345
|
-
|
|
346
|
-
|
|
381
|
+
mode?: "auto" | "local" | "remote" | "none";
|
|
382
|
+
supportedRevision?: number;
|
|
347
383
|
};
|
|
348
384
|
/**
|
|
349
385
|
* If false, third-party cookies are disabled to comply with GDPR regulations without asking for consent.
|
|
@@ -352,14 +388,22 @@ declare namespace Components {
|
|
|
352
388
|
};
|
|
353
389
|
validationRules?: /**
|
|
354
390
|
* References to validation rules organized by blocks and fields.
|
|
355
|
-
* Maps block IDs to either
|
|
391
|
+
* Maps block IDs to either one or more ordered rule IDs (for block-level rules)
|
|
392
|
+
* or rule references (for field-level rules).
|
|
356
393
|
*
|
|
357
394
|
* example:
|
|
358
395
|
* {
|
|
359
396
|
* "block1": "rule123",
|
|
360
|
-
* "block2":
|
|
361
|
-
* "
|
|
362
|
-
* "
|
|
397
|
+
* "block2": [
|
|
398
|
+
* "rule456",
|
|
399
|
+
* "rule789"
|
|
400
|
+
* ],
|
|
401
|
+
* "block3": {
|
|
402
|
+
* "field1": "rule101",
|
|
403
|
+
* "field2": [
|
|
404
|
+
* "rule102",
|
|
405
|
+
* "rule103"
|
|
406
|
+
* ]
|
|
363
407
|
* }
|
|
364
408
|
* }
|
|
365
409
|
*/
|
|
@@ -383,6 +427,18 @@ declare namespace Components {
|
|
|
383
427
|
[name: string]: any;
|
|
384
428
|
};
|
|
385
429
|
}
|
|
430
|
+
/**
|
|
431
|
+
* Journeys read from the API always carry an explicit `settings.isActive`. The flag remains optional in request bodies.
|
|
432
|
+
*
|
|
433
|
+
*/
|
|
434
|
+
export interface JourneyActivationGuarantee {
|
|
435
|
+
settings: {
|
|
436
|
+
/**
|
|
437
|
+
* Whether the journey is active (accessible to end customers)
|
|
438
|
+
*/
|
|
439
|
+
isActive: boolean;
|
|
440
|
+
};
|
|
441
|
+
}
|
|
386
442
|
export interface JourneyAuditInfo {
|
|
387
443
|
createdAt: string;
|
|
388
444
|
lastModifiedAt: string;
|
|
@@ -403,6 +459,7 @@ declare namespace Components {
|
|
|
403
459
|
showStepSubtitle?: boolean | null;
|
|
404
460
|
showStepper?: boolean | null;
|
|
405
461
|
showStepperLabels?: boolean | null;
|
|
462
|
+
stepperType?: "numbers" | "progress bar";
|
|
406
463
|
hideNextButton?: boolean | null;
|
|
407
464
|
name: string;
|
|
408
465
|
stepId?: string;
|
|
@@ -515,6 +572,10 @@ declare namespace Components {
|
|
|
515
572
|
* If type is not text, we can instruct the journey to fetch the entity id we receive as value
|
|
516
573
|
*/
|
|
517
574
|
shouldLoadEntity?: boolean;
|
|
575
|
+
/**
|
|
576
|
+
* Human-readable note describing the parameter's purpose. Free text; may contain newlines.
|
|
577
|
+
*/
|
|
578
|
+
description?: string | null;
|
|
518
579
|
}[];
|
|
519
580
|
/**
|
|
520
581
|
* Journey Template
|
|
@@ -533,7 +594,11 @@ declare namespace Components {
|
|
|
533
594
|
settings?: {
|
|
534
595
|
embedOptions?: {
|
|
535
596
|
mode?: "full-screen" | "inline";
|
|
536
|
-
|
|
597
|
+
/**
|
|
598
|
+
* example:
|
|
599
|
+
* de
|
|
600
|
+
*/
|
|
601
|
+
lang?: string;
|
|
537
602
|
width?: string;
|
|
538
603
|
topBar?: boolean;
|
|
539
604
|
scrollToTop?: boolean;
|
|
@@ -548,9 +613,13 @@ declare namespace Components {
|
|
|
548
613
|
*/
|
|
549
614
|
canary?: boolean;
|
|
550
615
|
designId: string;
|
|
551
|
-
templateId?: string;
|
|
616
|
+
templateId?: string | null;
|
|
552
617
|
entityId?: string | null;
|
|
553
618
|
mappingsAutomationId?: string;
|
|
619
|
+
/**
|
|
620
|
+
* When true, the journey is created without a mapping config or automation; mappings are managed as advanced mappings on a lazily created automation.
|
|
621
|
+
*/
|
|
622
|
+
newMappings?: boolean;
|
|
554
623
|
targetedCustomer?: string;
|
|
555
624
|
description?: string | null;
|
|
556
625
|
organizationSettings?: {
|
|
@@ -594,12 +663,21 @@ declare namespace Components {
|
|
|
594
663
|
*/
|
|
595
664
|
enableDarkMode?: boolean;
|
|
596
665
|
accessMode?: "PUBLIC" | "PRIVATE";
|
|
666
|
+
/**
|
|
667
|
+
* Steps after this step require an authenticated session (auth gate)
|
|
668
|
+
*/
|
|
669
|
+
authGate?: {
|
|
670
|
+
/**
|
|
671
|
+
* The step containing the Login & Registration block
|
|
672
|
+
*/
|
|
673
|
+
stepId: string;
|
|
674
|
+
};
|
|
597
675
|
isPublished?: boolean;
|
|
598
676
|
status?: string;
|
|
599
677
|
isActive?: boolean;
|
|
600
678
|
savingProgress?: {
|
|
601
|
-
|
|
602
|
-
|
|
679
|
+
mode?: "auto" | "local" | "remote" | "none";
|
|
680
|
+
supportedRevision?: number;
|
|
603
681
|
};
|
|
604
682
|
/**
|
|
605
683
|
* If false, third-party cookies are disabled to comply with GDPR regulations without asking for consent.
|
|
@@ -608,14 +686,22 @@ declare namespace Components {
|
|
|
608
686
|
};
|
|
609
687
|
validationRules?: /**
|
|
610
688
|
* References to validation rules organized by blocks and fields.
|
|
611
|
-
* Maps block IDs to either
|
|
689
|
+
* Maps block IDs to either one or more ordered rule IDs (for block-level rules)
|
|
690
|
+
* or rule references (for field-level rules).
|
|
612
691
|
*
|
|
613
692
|
* example:
|
|
614
693
|
* {
|
|
615
694
|
* "block1": "rule123",
|
|
616
|
-
* "block2":
|
|
617
|
-
* "
|
|
618
|
-
* "
|
|
695
|
+
* "block2": [
|
|
696
|
+
* "rule456",
|
|
697
|
+
* "rule789"
|
|
698
|
+
* ],
|
|
699
|
+
* "block3": {
|
|
700
|
+
* "field1": "rule101",
|
|
701
|
+
* "field2": [
|
|
702
|
+
* "rule102",
|
|
703
|
+
* "rule103"
|
|
704
|
+
* ]
|
|
619
705
|
* }
|
|
620
706
|
* }
|
|
621
707
|
*/
|
|
@@ -642,6 +728,7 @@ declare namespace Components {
|
|
|
642
728
|
showStepSubtitle?: boolean | null;
|
|
643
729
|
showStepper?: boolean | null;
|
|
644
730
|
showStepperLabels?: boolean | null;
|
|
731
|
+
stepperType?: "numbers" | "progress bar";
|
|
645
732
|
hideNextButton?: boolean | null;
|
|
646
733
|
name: string;
|
|
647
734
|
stepId?: string;
|
|
@@ -754,6 +841,10 @@ declare namespace Components {
|
|
|
754
841
|
* If type is not text, we can instruct the journey to fetch the entity id we receive as value
|
|
755
842
|
*/
|
|
756
843
|
shouldLoadEntity?: boolean;
|
|
844
|
+
/**
|
|
845
|
+
* Human-readable note describing the parameter's purpose. Free text; may contain newlines.
|
|
846
|
+
*/
|
|
847
|
+
description?: string | null;
|
|
757
848
|
}[];
|
|
758
849
|
/**
|
|
759
850
|
* Journey Template
|
|
@@ -772,7 +863,11 @@ declare namespace Components {
|
|
|
772
863
|
settings?: {
|
|
773
864
|
embedOptions?: {
|
|
774
865
|
mode?: "full-screen" | "inline";
|
|
775
|
-
|
|
866
|
+
/**
|
|
867
|
+
* example:
|
|
868
|
+
* de
|
|
869
|
+
*/
|
|
870
|
+
lang?: string;
|
|
776
871
|
width?: string;
|
|
777
872
|
topBar?: boolean;
|
|
778
873
|
scrollToTop?: boolean;
|
|
@@ -785,7 +880,11 @@ declare namespace Components {
|
|
|
785
880
|
designId?: string;
|
|
786
881
|
entityId?: string | null;
|
|
787
882
|
mappingsAutomationId?: string;
|
|
788
|
-
|
|
883
|
+
/**
|
|
884
|
+
* When true, the journey is created without a mapping config or automation; mappings are managed as advanced mappings on a lazily created automation.
|
|
885
|
+
*/
|
|
886
|
+
newMappings?: boolean;
|
|
887
|
+
templateId?: string | null;
|
|
789
888
|
targetedCustomer?: string;
|
|
790
889
|
description?: string | null;
|
|
791
890
|
publicToken?: string | null;
|
|
@@ -822,22 +921,47 @@ declare namespace Components {
|
|
|
822
921
|
*/
|
|
823
922
|
thirdPartyCookies?: boolean;
|
|
824
923
|
accessMode?: "PUBLIC" | "PRIVATE";
|
|
924
|
+
/**
|
|
925
|
+
* Steps after this step require an authenticated session (auth gate)
|
|
926
|
+
*/
|
|
927
|
+
authGate?: {
|
|
928
|
+
/**
|
|
929
|
+
* The step containing the Login & Registration block
|
|
930
|
+
*/
|
|
931
|
+
stepId: string;
|
|
932
|
+
};
|
|
825
933
|
/**
|
|
826
934
|
* If true, the journey shows an icon to toggle dark mode
|
|
827
935
|
*/
|
|
828
936
|
enableDarkMode?: boolean;
|
|
937
|
+
/**
|
|
938
|
+
* If true, some journey input labels are in Austrian format
|
|
939
|
+
*/
|
|
940
|
+
useAustrianLabels?: boolean;
|
|
829
941
|
isActive?: boolean;
|
|
942
|
+
savingProgress?: {
|
|
943
|
+
mode?: "auto" | "local" | "remote" | "none";
|
|
944
|
+
supportedRevision?: number;
|
|
945
|
+
};
|
|
830
946
|
};
|
|
831
947
|
validationRules?: /**
|
|
832
948
|
* References to validation rules organized by blocks and fields.
|
|
833
|
-
* Maps block IDs to either
|
|
949
|
+
* Maps block IDs to either one or more ordered rule IDs (for block-level rules)
|
|
950
|
+
* or rule references (for field-level rules).
|
|
834
951
|
*
|
|
835
952
|
* example:
|
|
836
953
|
* {
|
|
837
954
|
* "block1": "rule123",
|
|
838
|
-
* "block2":
|
|
839
|
-
* "
|
|
840
|
-
* "
|
|
955
|
+
* "block2": [
|
|
956
|
+
* "rule456",
|
|
957
|
+
* "rule789"
|
|
958
|
+
* ],
|
|
959
|
+
* "block3": {
|
|
960
|
+
* "field1": "rule101",
|
|
961
|
+
* "field2": [
|
|
962
|
+
* "rule102",
|
|
963
|
+
* "rule103"
|
|
964
|
+
* ]
|
|
841
965
|
* }
|
|
842
966
|
* }
|
|
843
967
|
*/
|
|
@@ -847,6 +971,17 @@ declare namespace Components {
|
|
|
847
971
|
*/
|
|
848
972
|
_manifest?: string /* uuid */[];
|
|
849
973
|
}
|
|
974
|
+
export interface JourneyEnvironmentResponse {
|
|
975
|
+
items: {
|
|
976
|
+
datasourceId: string;
|
|
977
|
+
type: "Text" | "Number" | "Boolean" | "Map";
|
|
978
|
+
value: string | number | boolean | EnvironmentMap;
|
|
979
|
+
}[];
|
|
980
|
+
errors: {
|
|
981
|
+
datasourceId: string;
|
|
982
|
+
code: "not_found" | "unsupported_type" | "not_set" | "invalid_value" | "incompatible_consumer";
|
|
983
|
+
}[];
|
|
984
|
+
}
|
|
850
985
|
export interface JourneyFeatureFlags {
|
|
851
986
|
featureFlags?: {
|
|
852
987
|
[name: string]: any;
|
|
@@ -954,17 +1089,22 @@ declare namespace Components {
|
|
|
954
1089
|
}
|
|
955
1090
|
/**
|
|
956
1091
|
* Field-level rule references within a block.
|
|
957
|
-
* Maps field names to rule IDs.
|
|
1092
|
+
* Maps field names to one or more ordered rule IDs.
|
|
958
1093
|
*
|
|
959
1094
|
* example:
|
|
960
1095
|
* {
|
|
961
1096
|
* "firstName": "rule123",
|
|
962
|
-
* "lastName":
|
|
963
|
-
*
|
|
1097
|
+
* "lastName": [
|
|
1098
|
+
* "rule456",
|
|
1099
|
+
* "rule789"
|
|
1100
|
+
* ]
|
|
964
1101
|
* }
|
|
965
1102
|
*/
|
|
966
1103
|
export interface RuleRef {
|
|
967
|
-
[name: string]: string
|
|
1104
|
+
[name: string]: string | [
|
|
1105
|
+
string,
|
|
1106
|
+
...string[]
|
|
1107
|
+
];
|
|
968
1108
|
}
|
|
969
1109
|
export interface S3Reference {
|
|
970
1110
|
/**
|
|
@@ -1178,27 +1318,40 @@ declare namespace Components {
|
|
|
1178
1318
|
}
|
|
1179
1319
|
/**
|
|
1180
1320
|
* References to validation rules organized by blocks and fields.
|
|
1181
|
-
* Maps block IDs to either
|
|
1321
|
+
* Maps block IDs to either one or more ordered rule IDs (for block-level rules)
|
|
1322
|
+
* or rule references (for field-level rules).
|
|
1182
1323
|
*
|
|
1183
1324
|
* example:
|
|
1184
1325
|
* {
|
|
1185
1326
|
* "block1": "rule123",
|
|
1186
|
-
* "block2":
|
|
1187
|
-
* "
|
|
1188
|
-
* "
|
|
1327
|
+
* "block2": [
|
|
1328
|
+
* "rule456",
|
|
1329
|
+
* "rule789"
|
|
1330
|
+
* ],
|
|
1331
|
+
* "block3": {
|
|
1332
|
+
* "field1": "rule101",
|
|
1333
|
+
* "field2": [
|
|
1334
|
+
* "rule102",
|
|
1335
|
+
* "rule103"
|
|
1336
|
+
* ]
|
|
1189
1337
|
* }
|
|
1190
1338
|
* }
|
|
1191
1339
|
*/
|
|
1192
1340
|
export interface ValidationRuleRef {
|
|
1193
|
-
[name: string]: string |
|
|
1341
|
+
[name: string]: string | [
|
|
1342
|
+
string,
|
|
1343
|
+
...string[]
|
|
1344
|
+
] | /**
|
|
1194
1345
|
* Field-level rule references within a block.
|
|
1195
|
-
* Maps field names to rule IDs.
|
|
1346
|
+
* Maps field names to one or more ordered rule IDs.
|
|
1196
1347
|
*
|
|
1197
1348
|
* example:
|
|
1198
1349
|
* {
|
|
1199
1350
|
* "firstName": "rule123",
|
|
1200
|
-
* "lastName":
|
|
1201
|
-
*
|
|
1351
|
+
* "lastName": [
|
|
1352
|
+
* "rule456",
|
|
1353
|
+
* "rule789"
|
|
1354
|
+
* ]
|
|
1202
1355
|
* }
|
|
1203
1356
|
*/
|
|
1204
1357
|
RuleRef;
|
|
@@ -1323,7 +1476,309 @@ declare namespace Paths {
|
|
|
1323
1476
|
orgId?: Parameters.OrgId;
|
|
1324
1477
|
}
|
|
1325
1478
|
namespace Responses {
|
|
1326
|
-
|
|
1479
|
+
/**
|
|
1480
|
+
* Journeys read from the API always carry an explicit `settings.isActive`. The flag remains optional in request bodies.
|
|
1481
|
+
*
|
|
1482
|
+
*/
|
|
1483
|
+
export interface $200 {
|
|
1484
|
+
[name: string]: any;
|
|
1485
|
+
journeyId?: string;
|
|
1486
|
+
organizationId: string;
|
|
1487
|
+
brandId?: string;
|
|
1488
|
+
name: string;
|
|
1489
|
+
steps: {
|
|
1490
|
+
showStepName?: boolean | null;
|
|
1491
|
+
title?: string | null;
|
|
1492
|
+
subTitle?: string | null;
|
|
1493
|
+
showStepSubtitle?: boolean | null;
|
|
1494
|
+
showStepper?: boolean | null;
|
|
1495
|
+
showStepperLabels?: boolean | null;
|
|
1496
|
+
stepperType?: "numbers" | "progress bar";
|
|
1497
|
+
hideNextButton?: boolean | null;
|
|
1498
|
+
name: string;
|
|
1499
|
+
stepId?: string;
|
|
1500
|
+
schema: any;
|
|
1501
|
+
uischema: any;
|
|
1502
|
+
maxWidth?: "small" | "medium" | "large" | "extra large";
|
|
1503
|
+
}[];
|
|
1504
|
+
design?: {
|
|
1505
|
+
logoUrl?: string | null;
|
|
1506
|
+
theme?: {
|
|
1507
|
+
[name: string]: any;
|
|
1508
|
+
};
|
|
1509
|
+
designTokens?: {
|
|
1510
|
+
[key: string]: any;
|
|
1511
|
+
};
|
|
1512
|
+
};
|
|
1513
|
+
rules?: {
|
|
1514
|
+
type: "inject" | "injectWithKey";
|
|
1515
|
+
sourceType: "journey" | "step" | "block";
|
|
1516
|
+
source: string;
|
|
1517
|
+
target: string;
|
|
1518
|
+
}[];
|
|
1519
|
+
logics?: {
|
|
1520
|
+
autoGeneratedId?: string;
|
|
1521
|
+
conditions: string[];
|
|
1522
|
+
actions: string[];
|
|
1523
|
+
}[];
|
|
1524
|
+
logicsV4?: {
|
|
1525
|
+
[name: string]: {
|
|
1526
|
+
/**
|
|
1527
|
+
* Unique identifier for logic. Use uuidv7
|
|
1528
|
+
*/
|
|
1529
|
+
id?: string; // uuid
|
|
1530
|
+
/**
|
|
1531
|
+
* If true, logic can't be manipulated by the configuring user
|
|
1532
|
+
*/
|
|
1533
|
+
protected?: boolean;
|
|
1534
|
+
/**
|
|
1535
|
+
* Indicates which action to take in case logic evaluates to true
|
|
1536
|
+
*/
|
|
1537
|
+
action?: string;
|
|
1538
|
+
/**
|
|
1539
|
+
* Indicates when the logic should be evaluated
|
|
1540
|
+
*/
|
|
1541
|
+
triggeredOn?: string;
|
|
1542
|
+
conditions?: {
|
|
1543
|
+
/**
|
|
1544
|
+
* Operator to be applied between the fact value and the value
|
|
1545
|
+
*/
|
|
1546
|
+
operator?: string;
|
|
1547
|
+
/**
|
|
1548
|
+
* If operator is a custom function, this needs to be provided
|
|
1549
|
+
*/
|
|
1550
|
+
functionName?: string;
|
|
1551
|
+
fact?: {
|
|
1552
|
+
/**
|
|
1553
|
+
* Unique identifier for a fact
|
|
1554
|
+
*/
|
|
1555
|
+
id?: string; // uuid
|
|
1556
|
+
/**
|
|
1557
|
+
* Indicates reference type (block or context parameter)
|
|
1558
|
+
*/
|
|
1559
|
+
referenceType?: string;
|
|
1560
|
+
/**
|
|
1561
|
+
* Id of the reference
|
|
1562
|
+
*/
|
|
1563
|
+
referenceId?: string;
|
|
1564
|
+
/**
|
|
1565
|
+
* Path to a property. Used if only part of the value is needed
|
|
1566
|
+
*/
|
|
1567
|
+
path?: string;
|
|
1568
|
+
/**
|
|
1569
|
+
* If path is a reference, indicates the intention of it
|
|
1570
|
+
*/
|
|
1571
|
+
meaning?: string;
|
|
1572
|
+
};
|
|
1573
|
+
value?: string | number | boolean | {
|
|
1574
|
+
[key: string]: any;
|
|
1575
|
+
} | any[];
|
|
1576
|
+
args?: {
|
|
1577
|
+
[key: string]: any;
|
|
1578
|
+
};
|
|
1579
|
+
}[][];
|
|
1580
|
+
/**
|
|
1581
|
+
* Logic specific settings. Will vary by type of logic
|
|
1582
|
+
*/
|
|
1583
|
+
settings?: {
|
|
1584
|
+
[key: string]: any;
|
|
1585
|
+
};
|
|
1586
|
+
};
|
|
1587
|
+
};
|
|
1588
|
+
contextSchema?: {
|
|
1589
|
+
/**
|
|
1590
|
+
* Unique identifier for the context schema item
|
|
1591
|
+
*/
|
|
1592
|
+
id?: string; // uuid
|
|
1593
|
+
/**
|
|
1594
|
+
* Type of the parameter. It could be either an entity slug, or a text
|
|
1595
|
+
*/
|
|
1596
|
+
type: string;
|
|
1597
|
+
/**
|
|
1598
|
+
* Expected key to be received in the context
|
|
1599
|
+
*/
|
|
1600
|
+
paramKey: string;
|
|
1601
|
+
/**
|
|
1602
|
+
* Indicates if a value is expected to be provided
|
|
1603
|
+
*/
|
|
1604
|
+
isRequired?: boolean;
|
|
1605
|
+
/**
|
|
1606
|
+
* If type is not text, we can instruct the journey to fetch the entity id we receive as value
|
|
1607
|
+
*/
|
|
1608
|
+
shouldLoadEntity?: boolean;
|
|
1609
|
+
/**
|
|
1610
|
+
* Human-readable note describing the parameter's purpose. Free text; may contain newlines.
|
|
1611
|
+
*/
|
|
1612
|
+
description?: string | null;
|
|
1613
|
+
}[];
|
|
1614
|
+
/**
|
|
1615
|
+
* Journey Template
|
|
1616
|
+
* example:
|
|
1617
|
+
* Sales template (Premium)
|
|
1618
|
+
*/
|
|
1619
|
+
journey_type?: string;
|
|
1620
|
+
/**
|
|
1621
|
+
* If true, journey is displayed in read-only mode
|
|
1622
|
+
*/
|
|
1623
|
+
protected?: boolean;
|
|
1624
|
+
/**
|
|
1625
|
+
* Whitelist of paths that remain editable when the journey is protected. Supports wildcard patterns (e.g. steps/*/blocks/**).
|
|
1626
|
+
*/
|
|
1627
|
+
protectedEditable?: string[];
|
|
1628
|
+
settings: {
|
|
1629
|
+
embedOptions?: {
|
|
1630
|
+
mode?: "full-screen" | "inline";
|
|
1631
|
+
/**
|
|
1632
|
+
* example:
|
|
1633
|
+
* de
|
|
1634
|
+
*/
|
|
1635
|
+
lang?: string;
|
|
1636
|
+
width?: string;
|
|
1637
|
+
topBar?: boolean;
|
|
1638
|
+
scrollToTop?: boolean;
|
|
1639
|
+
button?: {
|
|
1640
|
+
text?: string | null;
|
|
1641
|
+
align?: "left" | "center" | "right";
|
|
1642
|
+
};
|
|
1643
|
+
};
|
|
1644
|
+
safeModeAutomation?: boolean;
|
|
1645
|
+
/**
|
|
1646
|
+
* DEPRECATED - This API will return hardcoded value of false. Please note that this field is internal to epilot and should not be used by external clients. If you wish to get the canary flag, please use the /v1/journey/{id}/settings API.
|
|
1647
|
+
*/
|
|
1648
|
+
canary?: boolean;
|
|
1649
|
+
designId: string;
|
|
1650
|
+
templateId?: string | null;
|
|
1651
|
+
entityId?: string | null;
|
|
1652
|
+
mappingsAutomationId?: string;
|
|
1653
|
+
/**
|
|
1654
|
+
* When true, the journey is created without a mapping config or automation; mappings are managed as advanced mappings on a lazily created automation.
|
|
1655
|
+
*/
|
|
1656
|
+
newMappings?: boolean;
|
|
1657
|
+
targetedCustomer?: string;
|
|
1658
|
+
description?: string | null;
|
|
1659
|
+
organizationSettings?: {
|
|
1660
|
+
[name: string]: boolean;
|
|
1661
|
+
} | null;
|
|
1662
|
+
publicToken?: string | null;
|
|
1663
|
+
runtimeEntities?: ("ORDER" | "OPPORTUNITY")[];
|
|
1664
|
+
filePurposes?: string[];
|
|
1665
|
+
entityTags?: string[];
|
|
1666
|
+
/**
|
|
1667
|
+
* @deprecated Use addressSuggestionsFileId instead
|
|
1668
|
+
*/
|
|
1669
|
+
addressSuggestionsFileUrl?: string | null;
|
|
1670
|
+
addressSuggestionsFileId?: string | null;
|
|
1671
|
+
/**
|
|
1672
|
+
* Country code for address format (e.g. DE, AT, CH, LU)
|
|
1673
|
+
*/
|
|
1674
|
+
addressSuggestionsCountryCode?: string | null;
|
|
1675
|
+
/**
|
|
1676
|
+
* Whether address auto-complete is enabled
|
|
1677
|
+
*/
|
|
1678
|
+
addressSuggestionsEnableAutoComplete?: boolean;
|
|
1679
|
+
/**
|
|
1680
|
+
* Sources for address auto-complete (e.g. deutschePostService, customAddressesFile)
|
|
1681
|
+
*/
|
|
1682
|
+
addressSuggestionsSource?: string[];
|
|
1683
|
+
/**
|
|
1684
|
+
* Whether free text input is allowed when auto-complete is on
|
|
1685
|
+
*/
|
|
1686
|
+
addressSuggestionsEnableFreeText?: boolean;
|
|
1687
|
+
/**
|
|
1688
|
+
* This property is deprecated and will be removed in a future version
|
|
1689
|
+
*/
|
|
1690
|
+
useNewDesign?: boolean;
|
|
1691
|
+
/**
|
|
1692
|
+
* If true, some journey input labels are in Austrian format
|
|
1693
|
+
*/
|
|
1694
|
+
useAustrianLabels?: boolean;
|
|
1695
|
+
/**
|
|
1696
|
+
* If true, the journey shows an icon to toggle dark mode
|
|
1697
|
+
*/
|
|
1698
|
+
enableDarkMode?: boolean;
|
|
1699
|
+
accessMode?: "PUBLIC" | "PRIVATE";
|
|
1700
|
+
/**
|
|
1701
|
+
* Steps after this step require an authenticated session (auth gate)
|
|
1702
|
+
*/
|
|
1703
|
+
authGate?: {
|
|
1704
|
+
/**
|
|
1705
|
+
* The step containing the Login & Registration block
|
|
1706
|
+
*/
|
|
1707
|
+
stepId: string;
|
|
1708
|
+
};
|
|
1709
|
+
isPublished?: boolean;
|
|
1710
|
+
status?: string;
|
|
1711
|
+
/**
|
|
1712
|
+
* Whether the journey is active (accessible to end customers)
|
|
1713
|
+
*/
|
|
1714
|
+
isActive: boolean;
|
|
1715
|
+
savingProgress?: {
|
|
1716
|
+
mode?: "auto" | "local" | "remote" | "none";
|
|
1717
|
+
supportedRevision?: number;
|
|
1718
|
+
};
|
|
1719
|
+
/**
|
|
1720
|
+
* If false, third-party cookies are disabled to comply with GDPR regulations without asking for consent.
|
|
1721
|
+
*/
|
|
1722
|
+
thirdPartyCookies?: boolean;
|
|
1723
|
+
};
|
|
1724
|
+
validationRules?: /**
|
|
1725
|
+
* References to validation rules organized by blocks and fields.
|
|
1726
|
+
* Maps block IDs to either one or more ordered rule IDs (for block-level rules)
|
|
1727
|
+
* or rule references (for field-level rules).
|
|
1728
|
+
*
|
|
1729
|
+
* example:
|
|
1730
|
+
* {
|
|
1731
|
+
* "block1": "rule123",
|
|
1732
|
+
* "block2": [
|
|
1733
|
+
* "rule456",
|
|
1734
|
+
* "rule789"
|
|
1735
|
+
* ],
|
|
1736
|
+
* "block3": {
|
|
1737
|
+
* "field1": "rule101",
|
|
1738
|
+
* "field2": [
|
|
1739
|
+
* "rule102",
|
|
1740
|
+
* "rule103"
|
|
1741
|
+
* ]
|
|
1742
|
+
* }
|
|
1743
|
+
* }
|
|
1744
|
+
*/
|
|
1745
|
+
Components.Schemas.ValidationRuleRef;
|
|
1746
|
+
/**
|
|
1747
|
+
* Manifest/Blueprint ID used to create/update the entity
|
|
1748
|
+
*/
|
|
1749
|
+
_manifest?: string /* uuid */[];
|
|
1750
|
+
createdBy?: string;
|
|
1751
|
+
updatedBy?: string | null;
|
|
1752
|
+
/**
|
|
1753
|
+
* If passed with value of null, the API won't modify the lastModifiedAt field on updating the journey
|
|
1754
|
+
*/
|
|
1755
|
+
__lastModifiedAt?: string | null;
|
|
1756
|
+
createdAt: string;
|
|
1757
|
+
lastModifiedAt: string;
|
|
1758
|
+
deletedAt?: string;
|
|
1759
|
+
version: number;
|
|
1760
|
+
revisions: number;
|
|
1761
|
+
featureFlags?: {
|
|
1762
|
+
[name: string]: any;
|
|
1763
|
+
};
|
|
1764
|
+
}
|
|
1765
|
+
}
|
|
1766
|
+
}
|
|
1767
|
+
namespace GetJourneyEnvironment {
|
|
1768
|
+
namespace Parameters {
|
|
1769
|
+
export type Id = string; // uuid
|
|
1770
|
+
}
|
|
1771
|
+
export interface PathParameters {
|
|
1772
|
+
id: Parameters.Id /* uuid */;
|
|
1773
|
+
}
|
|
1774
|
+
namespace Responses {
|
|
1775
|
+
export type $200 = Components.Schemas.JourneyEnvironmentResponse;
|
|
1776
|
+
export interface $401 {
|
|
1777
|
+
}
|
|
1778
|
+
export interface $403 {
|
|
1779
|
+
}
|
|
1780
|
+
export interface $502 {
|
|
1781
|
+
}
|
|
1327
1782
|
}
|
|
1328
1783
|
}
|
|
1329
1784
|
namespace GetJourneyProducts {
|
|
@@ -1377,7 +1832,267 @@ declare namespace Paths {
|
|
|
1377
1832
|
version?: Parameters.Version;
|
|
1378
1833
|
}
|
|
1379
1834
|
namespace Responses {
|
|
1380
|
-
|
|
1835
|
+
/**
|
|
1836
|
+
* Journeys read from the API always carry an explicit `settings.isActive`. The flag remains optional in request bodies.
|
|
1837
|
+
*
|
|
1838
|
+
*/
|
|
1839
|
+
export interface $200 {
|
|
1840
|
+
journeyId?: string;
|
|
1841
|
+
brandId?: string;
|
|
1842
|
+
name: string;
|
|
1843
|
+
steps: {
|
|
1844
|
+
showStepName?: boolean | null;
|
|
1845
|
+
title?: string | null;
|
|
1846
|
+
subTitle?: string | null;
|
|
1847
|
+
showStepSubtitle?: boolean | null;
|
|
1848
|
+
showStepper?: boolean | null;
|
|
1849
|
+
showStepperLabels?: boolean | null;
|
|
1850
|
+
stepperType?: "numbers" | "progress bar";
|
|
1851
|
+
hideNextButton?: boolean | null;
|
|
1852
|
+
name: string;
|
|
1853
|
+
stepId?: string;
|
|
1854
|
+
schema: any;
|
|
1855
|
+
uischema: any;
|
|
1856
|
+
maxWidth?: "small" | "medium" | "large" | "extra large";
|
|
1857
|
+
}[];
|
|
1858
|
+
design?: {
|
|
1859
|
+
logoUrl?: string | null;
|
|
1860
|
+
theme?: {
|
|
1861
|
+
[name: string]: any;
|
|
1862
|
+
};
|
|
1863
|
+
designTokens?: {
|
|
1864
|
+
[key: string]: any;
|
|
1865
|
+
};
|
|
1866
|
+
};
|
|
1867
|
+
rules?: {
|
|
1868
|
+
type: "inject" | "injectWithKey";
|
|
1869
|
+
sourceType: "journey" | "step" | "block";
|
|
1870
|
+
source: string;
|
|
1871
|
+
target: string;
|
|
1872
|
+
}[];
|
|
1873
|
+
logics?: {
|
|
1874
|
+
autoGeneratedId?: string;
|
|
1875
|
+
conditions: string[];
|
|
1876
|
+
actions: string[];
|
|
1877
|
+
}[];
|
|
1878
|
+
logicsV4?: {
|
|
1879
|
+
[name: string]: {
|
|
1880
|
+
/**
|
|
1881
|
+
* Unique identifier for logic. Use uuidv7
|
|
1882
|
+
*/
|
|
1883
|
+
id?: string; // uuid
|
|
1884
|
+
/**
|
|
1885
|
+
* If true, logic can't be manipulated by the configuring user
|
|
1886
|
+
*/
|
|
1887
|
+
protected?: boolean;
|
|
1888
|
+
/**
|
|
1889
|
+
* Indicates which action to take in case logic evaluates to true
|
|
1890
|
+
*/
|
|
1891
|
+
action?: string;
|
|
1892
|
+
/**
|
|
1893
|
+
* Indicates when the logic should be evaluated
|
|
1894
|
+
*/
|
|
1895
|
+
triggeredOn?: string;
|
|
1896
|
+
conditions?: {
|
|
1897
|
+
/**
|
|
1898
|
+
* Operator to be applied between the fact value and the value
|
|
1899
|
+
*/
|
|
1900
|
+
operator?: string;
|
|
1901
|
+
/**
|
|
1902
|
+
* If operator is a custom function, this needs to be provided
|
|
1903
|
+
*/
|
|
1904
|
+
functionName?: string;
|
|
1905
|
+
fact?: {
|
|
1906
|
+
/**
|
|
1907
|
+
* Unique identifier for a fact
|
|
1908
|
+
*/
|
|
1909
|
+
id?: string; // uuid
|
|
1910
|
+
/**
|
|
1911
|
+
* Indicates reference type (block or context parameter)
|
|
1912
|
+
*/
|
|
1913
|
+
referenceType?: string;
|
|
1914
|
+
/**
|
|
1915
|
+
* Id of the reference
|
|
1916
|
+
*/
|
|
1917
|
+
referenceId?: string;
|
|
1918
|
+
/**
|
|
1919
|
+
* Path to a property. Used if only part of the value is needed
|
|
1920
|
+
*/
|
|
1921
|
+
path?: string;
|
|
1922
|
+
/**
|
|
1923
|
+
* If path is a reference, indicates the intention of it
|
|
1924
|
+
*/
|
|
1925
|
+
meaning?: string;
|
|
1926
|
+
};
|
|
1927
|
+
value?: string | number | boolean | {
|
|
1928
|
+
[key: string]: any;
|
|
1929
|
+
} | any[];
|
|
1930
|
+
args?: {
|
|
1931
|
+
[key: string]: any;
|
|
1932
|
+
};
|
|
1933
|
+
}[][];
|
|
1934
|
+
/**
|
|
1935
|
+
* Logic specific settings. Will vary by type of logic
|
|
1936
|
+
*/
|
|
1937
|
+
settings?: {
|
|
1938
|
+
[key: string]: any;
|
|
1939
|
+
};
|
|
1940
|
+
};
|
|
1941
|
+
};
|
|
1942
|
+
contextSchema?: {
|
|
1943
|
+
/**
|
|
1944
|
+
* Unique identifier for the context schema item
|
|
1945
|
+
*/
|
|
1946
|
+
id?: string; // uuid
|
|
1947
|
+
/**
|
|
1948
|
+
* Type of the parameter. It could be either an entity slug, or a text
|
|
1949
|
+
*/
|
|
1950
|
+
type: string;
|
|
1951
|
+
/**
|
|
1952
|
+
* Expected key to be received in the context
|
|
1953
|
+
*/
|
|
1954
|
+
paramKey: string;
|
|
1955
|
+
/**
|
|
1956
|
+
* Indicates if a value is expected to be provided
|
|
1957
|
+
*/
|
|
1958
|
+
isRequired?: boolean;
|
|
1959
|
+
/**
|
|
1960
|
+
* If type is not text, we can instruct the journey to fetch the entity id we receive as value
|
|
1961
|
+
*/
|
|
1962
|
+
shouldLoadEntity?: boolean;
|
|
1963
|
+
/**
|
|
1964
|
+
* Human-readable note describing the parameter's purpose. Free text; may contain newlines.
|
|
1965
|
+
*/
|
|
1966
|
+
description?: string | null;
|
|
1967
|
+
}[];
|
|
1968
|
+
/**
|
|
1969
|
+
* Journey Template
|
|
1970
|
+
* example:
|
|
1971
|
+
* Sales template (Premium)
|
|
1972
|
+
*/
|
|
1973
|
+
journey_type?: string;
|
|
1974
|
+
/**
|
|
1975
|
+
* If true, journey is displayed in read-only mode
|
|
1976
|
+
*/
|
|
1977
|
+
protected?: boolean;
|
|
1978
|
+
/**
|
|
1979
|
+
* Whitelist of paths that remain editable when the journey is protected. Supports wildcard patterns (e.g. steps/*/blocks/**).
|
|
1980
|
+
*/
|
|
1981
|
+
protectedEditable?: string[];
|
|
1982
|
+
settings: {
|
|
1983
|
+
embedOptions?: {
|
|
1984
|
+
mode?: "full-screen" | "inline";
|
|
1985
|
+
/**
|
|
1986
|
+
* example:
|
|
1987
|
+
* de
|
|
1988
|
+
*/
|
|
1989
|
+
lang?: string;
|
|
1990
|
+
width?: string;
|
|
1991
|
+
topBar?: boolean;
|
|
1992
|
+
scrollToTop?: boolean;
|
|
1993
|
+
button?: {
|
|
1994
|
+
text?: string | null;
|
|
1995
|
+
align?: "left" | "center" | "right";
|
|
1996
|
+
};
|
|
1997
|
+
};
|
|
1998
|
+
safeModeAutomation?: boolean;
|
|
1999
|
+
designId?: string;
|
|
2000
|
+
entityId?: string | null;
|
|
2001
|
+
mappingsAutomationId?: string;
|
|
2002
|
+
/**
|
|
2003
|
+
* When true, the journey is created without a mapping config or automation; mappings are managed as advanced mappings on a lazily created automation.
|
|
2004
|
+
*/
|
|
2005
|
+
newMappings?: boolean;
|
|
2006
|
+
templateId?: string | null;
|
|
2007
|
+
targetedCustomer?: string;
|
|
2008
|
+
description?: string | null;
|
|
2009
|
+
publicToken?: string | null;
|
|
2010
|
+
runtimeEntities?: ("ORDER" | "OPPORTUNITY")[];
|
|
2011
|
+
filePurposes?: string[];
|
|
2012
|
+
entityTags?: string[];
|
|
2013
|
+
/**
|
|
2014
|
+
* @deprecated Use addressSuggestionsFileId instead
|
|
2015
|
+
*/
|
|
2016
|
+
addressSuggestionsFileUrl?: string | null;
|
|
2017
|
+
addressSuggestionsFileId?: string | null;
|
|
2018
|
+
/**
|
|
2019
|
+
* Country code for address format (e.g. DE, AT, CH, LU)
|
|
2020
|
+
*/
|
|
2021
|
+
addressSuggestionsCountryCode?: string | null;
|
|
2022
|
+
/**
|
|
2023
|
+
* Whether address auto-complete is enabled
|
|
2024
|
+
*/
|
|
2025
|
+
addressSuggestionsEnableAutoComplete?: boolean;
|
|
2026
|
+
/**
|
|
2027
|
+
* Sources for address auto-complete (e.g. deutschePostService, customAddressesFile)
|
|
2028
|
+
*/
|
|
2029
|
+
addressSuggestionsSource?: string[];
|
|
2030
|
+
/**
|
|
2031
|
+
* Whether free text input is allowed when auto-complete is on
|
|
2032
|
+
*/
|
|
2033
|
+
addressSuggestionsEnableFreeText?: boolean;
|
|
2034
|
+
/**
|
|
2035
|
+
* This property is deprecated and will be removed in a future version
|
|
2036
|
+
*/
|
|
2037
|
+
useNewDesign?: boolean;
|
|
2038
|
+
/**
|
|
2039
|
+
* If false, third-party cookies are disabled to comply with GDPR regulations without asking for consent.
|
|
2040
|
+
*/
|
|
2041
|
+
thirdPartyCookies?: boolean;
|
|
2042
|
+
accessMode?: "PUBLIC" | "PRIVATE";
|
|
2043
|
+
/**
|
|
2044
|
+
* Steps after this step require an authenticated session (auth gate)
|
|
2045
|
+
*/
|
|
2046
|
+
authGate?: {
|
|
2047
|
+
/**
|
|
2048
|
+
* The step containing the Login & Registration block
|
|
2049
|
+
*/
|
|
2050
|
+
stepId: string;
|
|
2051
|
+
};
|
|
2052
|
+
/**
|
|
2053
|
+
* If true, the journey shows an icon to toggle dark mode
|
|
2054
|
+
*/
|
|
2055
|
+
enableDarkMode?: boolean;
|
|
2056
|
+
/**
|
|
2057
|
+
* If true, some journey input labels are in Austrian format
|
|
2058
|
+
*/
|
|
2059
|
+
useAustrianLabels?: boolean;
|
|
2060
|
+
/**
|
|
2061
|
+
* Whether the journey is active (accessible to end customers)
|
|
2062
|
+
*/
|
|
2063
|
+
isActive: boolean;
|
|
2064
|
+
savingProgress?: {
|
|
2065
|
+
mode?: "auto" | "local" | "remote" | "none";
|
|
2066
|
+
supportedRevision?: number;
|
|
2067
|
+
};
|
|
2068
|
+
};
|
|
2069
|
+
validationRules?: /**
|
|
2070
|
+
* References to validation rules organized by blocks and fields.
|
|
2071
|
+
* Maps block IDs to either one or more ordered rule IDs (for block-level rules)
|
|
2072
|
+
* or rule references (for field-level rules).
|
|
2073
|
+
*
|
|
2074
|
+
* example:
|
|
2075
|
+
* {
|
|
2076
|
+
* "block1": "rule123",
|
|
2077
|
+
* "block2": [
|
|
2078
|
+
* "rule456",
|
|
2079
|
+
* "rule789"
|
|
2080
|
+
* ],
|
|
2081
|
+
* "block3": {
|
|
2082
|
+
* "field1": "rule101",
|
|
2083
|
+
* "field2": [
|
|
2084
|
+
* "rule102",
|
|
2085
|
+
* "rule103"
|
|
2086
|
+
* ]
|
|
2087
|
+
* }
|
|
2088
|
+
* }
|
|
2089
|
+
*/
|
|
2090
|
+
Components.Schemas.ValidationRuleRef;
|
|
2091
|
+
/**
|
|
2092
|
+
* Manifest/Blueprint ID used to create/update the entity
|
|
2093
|
+
*/
|
|
2094
|
+
_manifest?: string /* uuid */[];
|
|
2095
|
+
}
|
|
1381
2096
|
}
|
|
1382
2097
|
}
|
|
1383
2098
|
namespace GetJourneysByOrgId {
|
|
@@ -1585,6 +2300,16 @@ interface OperationMethods {
|
|
|
1585
2300
|
data?: any,
|
|
1586
2301
|
config?: AxiosRequestConfig
|
|
1587
2302
|
): OperationResponse<any>
|
|
2303
|
+
/**
|
|
2304
|
+
* getJourneyEnvironment - getJourneyEnvironment
|
|
2305
|
+
*
|
|
2306
|
+
* Resolve the environment variables referenced by this journey. Only browser-safe value types are returned.
|
|
2307
|
+
*/
|
|
2308
|
+
'getJourneyEnvironment'(
|
|
2309
|
+
parameters?: Parameters<Paths.GetJourneyEnvironment.PathParameters> | null,
|
|
2310
|
+
data?: any,
|
|
2311
|
+
config?: AxiosRequestConfig
|
|
2312
|
+
): OperationResponse<Paths.GetJourneyEnvironment.Responses.$200>
|
|
1588
2313
|
/**
|
|
1589
2314
|
* getJourneyProducts - getJourneyProducts
|
|
1590
2315
|
*
|
|
@@ -1763,6 +2488,18 @@ interface PathsDictionary {
|
|
|
1763
2488
|
config?: AxiosRequestConfig
|
|
1764
2489
|
): OperationResponse<any>
|
|
1765
2490
|
}
|
|
2491
|
+
['/v1/journey/configuration/{id}/environment']: {
|
|
2492
|
+
/**
|
|
2493
|
+
* getJourneyEnvironment - getJourneyEnvironment
|
|
2494
|
+
*
|
|
2495
|
+
* Resolve the environment variables referenced by this journey. Only browser-safe value types are returned.
|
|
2496
|
+
*/
|
|
2497
|
+
'get'(
|
|
2498
|
+
parameters?: Parameters<Paths.GetJourneyEnvironment.PathParameters> | null,
|
|
2499
|
+
data?: any,
|
|
2500
|
+
config?: AxiosRequestConfig
|
|
2501
|
+
): OperationResponse<Paths.GetJourneyEnvironment.Responses.$200>
|
|
2502
|
+
}
|
|
1766
2503
|
['/v1/journey/products/{id}']: {
|
|
1767
2504
|
/**
|
|
1768
2505
|
* getJourneyProducts - getJourneyProducts
|
|
@@ -1926,14 +2663,18 @@ type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
|
1926
2663
|
|
|
1927
2664
|
|
|
1928
2665
|
type ButtonOption = Components.Schemas.ButtonOption;
|
|
2666
|
+
type EnvironmentMap = Components.Schemas.EnvironmentMap;
|
|
2667
|
+
type EnvironmentMapEntry = Components.Schemas.EnvironmentMapEntry;
|
|
1929
2668
|
type GenerateDocumentRequest = Components.Schemas.GenerateDocumentRequest;
|
|
1930
2669
|
type GenerateDocumentResponse = Components.Schemas.GenerateDocumentResponse;
|
|
1931
2670
|
type GetJourneysResponse = Components.Schemas.GetJourneysResponse;
|
|
1932
2671
|
type GetSettingsForJourney = Components.Schemas.GetSettingsForJourney;
|
|
1933
2672
|
type Journey = Components.Schemas.Journey;
|
|
2673
|
+
type JourneyActivationGuarantee = Components.Schemas.JourneyActivationGuarantee;
|
|
1934
2674
|
type JourneyAuditInfo = Components.Schemas.JourneyAuditInfo;
|
|
1935
2675
|
type JourneyCreationRequest = Components.Schemas.JourneyCreationRequest;
|
|
1936
2676
|
type JourneyCreationRequestV2 = Components.Schemas.JourneyCreationRequestV2;
|
|
2677
|
+
type JourneyEnvironmentResponse = Components.Schemas.JourneyEnvironmentResponse;
|
|
1937
2678
|
type JourneyFeatureFlags = Components.Schemas.JourneyFeatureFlags;
|
|
1938
2679
|
type JourneyProductsResponse = Components.Schemas.JourneyProductsResponse;
|
|
1939
2680
|
type JourneyResponse = Components.Schemas.JourneyResponse;
|
|
@@ -1947,4 +2688,4 @@ type SearchJourneysResponse = Components.Schemas.SearchJourneysResponse;
|
|
|
1947
2688
|
type TemplateSettings = Components.Schemas.TemplateSettings;
|
|
1948
2689
|
type ValidationRuleRef = Components.Schemas.ValidationRuleRef;
|
|
1949
2690
|
|
|
1950
|
-
export { type ButtonOption as B, type Client as C, type GenerateDocumentRequest as G, type Journey as J, type OperationMethods as O, Paths as P, type RuleRef as R, type S3Reference as S, type TemplateSettings as T, type ValidationRuleRef as V, Components as a, type PathsDictionary as b, type
|
|
2691
|
+
export { type ButtonOption as B, type Client as C, type EnvironmentMap as E, type GenerateDocumentRequest as G, type Journey as J, type OperationMethods as O, Paths as P, type RuleRef as R, type S3Reference as S, type TemplateSettings as T, type ValidationRuleRef as V, Components as a, type PathsDictionary as b, type EnvironmentMapEntry as c, type GenerateDocumentResponse as d, type GetJourneysResponse as e, GetSettingsForJourney as f, type JourneyActivationGuarantee as g, type JourneyAuditInfo as h, type JourneyCreationRequest as i, type JourneyCreationRequestV2 as j, type JourneyEnvironmentResponse as k, type JourneyFeatureFlags as l, type JourneyProductsResponse as m, type JourneyResponse as n, type JourneyValidationError as o, type JourneyValidationResponse as p, type PatchUpdateJourneyRequest as q, type SearchJourneysQueryRequest as r, type SearchJourneysResponse as s };
|