@epilot/journey-client 0.5.3 → 0.6.0-alpha.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/dist/definition.js +1 -1
- package/dist/openapi.d.ts +819 -36
- package/package.json +12 -11
package/dist/definition.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
(()=>{"use strict";var e={223(e,r,
|
|
1
|
+
(()=>{"use strict";var e={223(e,r,n){var t=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var o=t(n(466));r.default=o.default},466(e){e.exports=JSON.parse('{"openapi":"3.0.0","info":{"title":"","version":""},"paths":{"/v1/journey/organization/{id}":{"get":{"operationId":"getJourneysByOrgId","parameters":[{"name":"id","in":"path","required":true},{"name":"hydrate","in":"query","required":false}],"responses":{}}},"/v1/journey/configuration/{id}":{"get":{"operationId":"getJourney","parameters":[{"name":"id","in":"path","required":true},{"name":"version","in":"query","required":false},{"name":"source","in":"query","required":false},{"name":"orgId","in":"query","required":false}],"responses":{}},"delete":{"operationId":"removeJourney","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/journey/configuration/{id}/environment":{"get":{"operationId":"getJourneyEnvironment","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/journey/environment-variables":{"get":{"operationId":"getJourneyEnvironmentVariables","responses":{}}},"/v1/journey/products/{id}":{"get":{"operationId":"getJourneyProducts","parameters":[{"name":"id","in":"path","required":true},{"name":"source","in":"query","required":false},{"name":"postal_code","in":"query","required":false},{"name":"city","in":"query","required":false},{"name":"street","in":"query","required":false},{"name":"street_number","in":"query","required":false}],"responses":{}}},"/v1/journey/configuration":{"post":{"operationId":"createJourney","requestBody":{"content":{"application/json":{}}},"parameters":[{"name":"skipAutomation","in":"query","required":false}],"responses":{}},"put":{"operationId":"updateJourney","requestBody":{"content":{"application/json":{}}},"parameters":[],"responses":{}},"patch":{"operationId":"patchUpdateJourney","requestBody":{"content":{"application/json":{}}},"parameters":[],"responses":{}}},"/v1/journey/configuration/search":{"post":{"operationId":"searchJourneys","requestBody":{"content":{"application/json":{}}},"parameters":[],"responses":{}}},"/v1/journey/document:generate":{"post":{"operationId":"generateDocument","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/journey/configuration":{"post":{"operationId":"createJourneyV2","requestBody":{"content":{"application/json":{}}},"parameters":[{"name":"skipAutomation","in":"query","required":false}],"responses":{}},"put":{"operationId":"updateJourneyV2","requestBody":{"content":{"application/json":{}}},"parameters":[],"responses":{}},"patch":{"operationId":"patchUpdateJourneyV2","requestBody":{"content":{"application/json":{}}},"parameters":[],"responses":{}}},"/v2/journey/configuration/{id}":{"get":{"operationId":"getJourneyV2","parameters":[{"name":"id","in":"path","required":true},{"name":"version","in":"query","required":false}],"responses":{}},"delete":{"operationId":"removeJourneyV2","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/journey/{id}/settings":{"get":{"operationId":"getSettingsForJourney","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/journey/button-options":{"get":{"operationId":"getButtonOptions","parameters":[{"in":"query","name":"fileId","required":true}],"responses":{}}}},"components":{},"servers":[{"url":"https://journey-config.sls.epilot.io"}]}')}},r={},n=function n(t){var o=r[t];if(void 0!==o)return o.exports;var a=r[t]={exports:{}};return e[t].call(a.exports,a,a.exports,n),a.exports}(223),t=exports;for(var o in n)t[o]=n[o];n.__esModule&&Object.defineProperty(t,"__esModule",{value:!0})})();
|
package/dist/openapi.d.ts
CHANGED
|
@@ -25,6 +25,16 @@ declare namespace Components {
|
|
|
25
25
|
*/
|
|
26
26
|
label?: string;
|
|
27
27
|
}
|
|
28
|
+
export interface EnvironmentMap {
|
|
29
|
+
fallbackLanguage?: string;
|
|
30
|
+
options: EnvironmentMapEntry[];
|
|
31
|
+
}
|
|
32
|
+
export interface EnvironmentMapEntry {
|
|
33
|
+
key: string;
|
|
34
|
+
value: string | {
|
|
35
|
+
[name: string]: string;
|
|
36
|
+
};
|
|
37
|
+
}
|
|
28
38
|
export interface GenerateDocumentRequest {
|
|
29
39
|
/**
|
|
30
40
|
* Entity id for the template being used
|
|
@@ -38,6 +48,10 @@ declare namespace Components {
|
|
|
38
48
|
context_data: {
|
|
39
49
|
additionalProperties?: string;
|
|
40
50
|
};
|
|
51
|
+
/**
|
|
52
|
+
* Entity id used to resolve entity and relational template variables
|
|
53
|
+
*/
|
|
54
|
+
context_entity_id?: string; // uuid
|
|
41
55
|
/**
|
|
42
56
|
* Language code for the document
|
|
43
57
|
* example:
|
|
@@ -150,6 +164,7 @@ declare namespace Components {
|
|
|
150
164
|
showStepSubtitle?: boolean | null;
|
|
151
165
|
showStepper?: boolean | null;
|
|
152
166
|
showStepperLabels?: boolean | null;
|
|
167
|
+
stepperType?: "numbers" | "progress bar";
|
|
153
168
|
hideNextButton?: boolean | null;
|
|
154
169
|
name: string;
|
|
155
170
|
stepId?: string;
|
|
@@ -262,6 +277,10 @@ declare namespace Components {
|
|
|
262
277
|
* If type is not text, we can instruct the journey to fetch the entity id we receive as value
|
|
263
278
|
*/
|
|
264
279
|
shouldLoadEntity?: boolean;
|
|
280
|
+
/**
|
|
281
|
+
* Human-readable note describing the parameter's purpose. Free text; may contain newlines.
|
|
282
|
+
*/
|
|
283
|
+
description?: string | null;
|
|
265
284
|
}[];
|
|
266
285
|
/**
|
|
267
286
|
* Journey Template
|
|
@@ -280,7 +299,11 @@ declare namespace Components {
|
|
|
280
299
|
settings?: {
|
|
281
300
|
embedOptions?: {
|
|
282
301
|
mode?: "full-screen" | "inline";
|
|
283
|
-
|
|
302
|
+
/**
|
|
303
|
+
* example:
|
|
304
|
+
* de
|
|
305
|
+
*/
|
|
306
|
+
lang?: string;
|
|
284
307
|
width?: string;
|
|
285
308
|
topBar?: boolean;
|
|
286
309
|
scrollToTop?: boolean;
|
|
@@ -295,9 +318,13 @@ declare namespace Components {
|
|
|
295
318
|
*/
|
|
296
319
|
canary?: boolean;
|
|
297
320
|
designId: string;
|
|
298
|
-
templateId?: string;
|
|
321
|
+
templateId?: string | null;
|
|
299
322
|
entityId?: string | null;
|
|
300
323
|
mappingsAutomationId?: string;
|
|
324
|
+
/**
|
|
325
|
+
* When true, the journey is created without a mapping config or automation; mappings are managed as advanced mappings on a lazily created automation.
|
|
326
|
+
*/
|
|
327
|
+
newMappings?: boolean;
|
|
301
328
|
targetedCustomer?: string;
|
|
302
329
|
description?: string | null;
|
|
303
330
|
organizationSettings?: {
|
|
@@ -341,12 +368,21 @@ declare namespace Components {
|
|
|
341
368
|
*/
|
|
342
369
|
enableDarkMode?: boolean;
|
|
343
370
|
accessMode?: "PUBLIC" | "PRIVATE";
|
|
371
|
+
/**
|
|
372
|
+
* Steps after this step require an authenticated session (auth gate)
|
|
373
|
+
*/
|
|
374
|
+
authGate?: {
|
|
375
|
+
/**
|
|
376
|
+
* The step containing the Login & Registration block
|
|
377
|
+
*/
|
|
378
|
+
stepId: string;
|
|
379
|
+
};
|
|
344
380
|
isPublished?: boolean;
|
|
345
381
|
status?: string;
|
|
346
382
|
isActive?: boolean;
|
|
347
383
|
savingProgress?: {
|
|
348
|
-
|
|
349
|
-
|
|
384
|
+
mode?: "auto" | "local" | "remote" | "none";
|
|
385
|
+
supportedRevision?: number;
|
|
350
386
|
};
|
|
351
387
|
/**
|
|
352
388
|
* If false, third-party cookies are disabled to comply with GDPR regulations without asking for consent.
|
|
@@ -355,14 +391,22 @@ declare namespace Components {
|
|
|
355
391
|
};
|
|
356
392
|
validationRules?: /**
|
|
357
393
|
* References to validation rules organized by blocks and fields.
|
|
358
|
-
* Maps block IDs to either
|
|
394
|
+
* Maps block IDs to either one or more ordered rule IDs (for block-level rules)
|
|
395
|
+
* or rule references (for field-level rules).
|
|
359
396
|
*
|
|
360
397
|
* example:
|
|
361
398
|
* {
|
|
362
399
|
* "block1": "rule123",
|
|
363
|
-
* "block2":
|
|
364
|
-
* "
|
|
365
|
-
* "
|
|
400
|
+
* "block2": [
|
|
401
|
+
* "rule456",
|
|
402
|
+
* "rule789"
|
|
403
|
+
* ],
|
|
404
|
+
* "block3": {
|
|
405
|
+
* "field1": "rule101",
|
|
406
|
+
* "field2": [
|
|
407
|
+
* "rule102",
|
|
408
|
+
* "rule103"
|
|
409
|
+
* ]
|
|
366
410
|
* }
|
|
367
411
|
* }
|
|
368
412
|
*/
|
|
@@ -386,6 +430,18 @@ declare namespace Components {
|
|
|
386
430
|
[name: string]: any;
|
|
387
431
|
};
|
|
388
432
|
}
|
|
433
|
+
/**
|
|
434
|
+
* Journeys read from the API always carry an explicit `settings.isActive`. The flag remains optional in request bodies.
|
|
435
|
+
*
|
|
436
|
+
*/
|
|
437
|
+
export interface JourneyActivationGuarantee {
|
|
438
|
+
settings: {
|
|
439
|
+
/**
|
|
440
|
+
* Whether the journey is active (accessible to end customers)
|
|
441
|
+
*/
|
|
442
|
+
isActive: boolean;
|
|
443
|
+
};
|
|
444
|
+
}
|
|
389
445
|
export interface JourneyAuditInfo {
|
|
390
446
|
createdAt: string;
|
|
391
447
|
lastModifiedAt: string;
|
|
@@ -406,6 +462,7 @@ declare namespace Components {
|
|
|
406
462
|
showStepSubtitle?: boolean | null;
|
|
407
463
|
showStepper?: boolean | null;
|
|
408
464
|
showStepperLabels?: boolean | null;
|
|
465
|
+
stepperType?: "numbers" | "progress bar";
|
|
409
466
|
hideNextButton?: boolean | null;
|
|
410
467
|
name: string;
|
|
411
468
|
stepId?: string;
|
|
@@ -518,6 +575,10 @@ declare namespace Components {
|
|
|
518
575
|
* If type is not text, we can instruct the journey to fetch the entity id we receive as value
|
|
519
576
|
*/
|
|
520
577
|
shouldLoadEntity?: boolean;
|
|
578
|
+
/**
|
|
579
|
+
* Human-readable note describing the parameter's purpose. Free text; may contain newlines.
|
|
580
|
+
*/
|
|
581
|
+
description?: string | null;
|
|
521
582
|
}[];
|
|
522
583
|
/**
|
|
523
584
|
* Journey Template
|
|
@@ -536,7 +597,11 @@ declare namespace Components {
|
|
|
536
597
|
settings?: {
|
|
537
598
|
embedOptions?: {
|
|
538
599
|
mode?: "full-screen" | "inline";
|
|
539
|
-
|
|
600
|
+
/**
|
|
601
|
+
* example:
|
|
602
|
+
* de
|
|
603
|
+
*/
|
|
604
|
+
lang?: string;
|
|
540
605
|
width?: string;
|
|
541
606
|
topBar?: boolean;
|
|
542
607
|
scrollToTop?: boolean;
|
|
@@ -551,9 +616,13 @@ declare namespace Components {
|
|
|
551
616
|
*/
|
|
552
617
|
canary?: boolean;
|
|
553
618
|
designId: string;
|
|
554
|
-
templateId?: string;
|
|
619
|
+
templateId?: string | null;
|
|
555
620
|
entityId?: string | null;
|
|
556
621
|
mappingsAutomationId?: string;
|
|
622
|
+
/**
|
|
623
|
+
* When true, the journey is created without a mapping config or automation; mappings are managed as advanced mappings on a lazily created automation.
|
|
624
|
+
*/
|
|
625
|
+
newMappings?: boolean;
|
|
557
626
|
targetedCustomer?: string;
|
|
558
627
|
description?: string | null;
|
|
559
628
|
organizationSettings?: {
|
|
@@ -597,12 +666,21 @@ declare namespace Components {
|
|
|
597
666
|
*/
|
|
598
667
|
enableDarkMode?: boolean;
|
|
599
668
|
accessMode?: "PUBLIC" | "PRIVATE";
|
|
669
|
+
/**
|
|
670
|
+
* Steps after this step require an authenticated session (auth gate)
|
|
671
|
+
*/
|
|
672
|
+
authGate?: {
|
|
673
|
+
/**
|
|
674
|
+
* The step containing the Login & Registration block
|
|
675
|
+
*/
|
|
676
|
+
stepId: string;
|
|
677
|
+
};
|
|
600
678
|
isPublished?: boolean;
|
|
601
679
|
status?: string;
|
|
602
680
|
isActive?: boolean;
|
|
603
681
|
savingProgress?: {
|
|
604
|
-
|
|
605
|
-
|
|
682
|
+
mode?: "auto" | "local" | "remote" | "none";
|
|
683
|
+
supportedRevision?: number;
|
|
606
684
|
};
|
|
607
685
|
/**
|
|
608
686
|
* If false, third-party cookies are disabled to comply with GDPR regulations without asking for consent.
|
|
@@ -611,14 +689,22 @@ declare namespace Components {
|
|
|
611
689
|
};
|
|
612
690
|
validationRules?: /**
|
|
613
691
|
* References to validation rules organized by blocks and fields.
|
|
614
|
-
* Maps block IDs to either
|
|
692
|
+
* Maps block IDs to either one or more ordered rule IDs (for block-level rules)
|
|
693
|
+
* or rule references (for field-level rules).
|
|
615
694
|
*
|
|
616
695
|
* example:
|
|
617
696
|
* {
|
|
618
697
|
* "block1": "rule123",
|
|
619
|
-
* "block2":
|
|
620
|
-
* "
|
|
621
|
-
* "
|
|
698
|
+
* "block2": [
|
|
699
|
+
* "rule456",
|
|
700
|
+
* "rule789"
|
|
701
|
+
* ],
|
|
702
|
+
* "block3": {
|
|
703
|
+
* "field1": "rule101",
|
|
704
|
+
* "field2": [
|
|
705
|
+
* "rule102",
|
|
706
|
+
* "rule103"
|
|
707
|
+
* ]
|
|
622
708
|
* }
|
|
623
709
|
* }
|
|
624
710
|
*/
|
|
@@ -645,6 +731,7 @@ declare namespace Components {
|
|
|
645
731
|
showStepSubtitle?: boolean | null;
|
|
646
732
|
showStepper?: boolean | null;
|
|
647
733
|
showStepperLabels?: boolean | null;
|
|
734
|
+
stepperType?: "numbers" | "progress bar";
|
|
648
735
|
hideNextButton?: boolean | null;
|
|
649
736
|
name: string;
|
|
650
737
|
stepId?: string;
|
|
@@ -757,6 +844,10 @@ declare namespace Components {
|
|
|
757
844
|
* If type is not text, we can instruct the journey to fetch the entity id we receive as value
|
|
758
845
|
*/
|
|
759
846
|
shouldLoadEntity?: boolean;
|
|
847
|
+
/**
|
|
848
|
+
* Human-readable note describing the parameter's purpose. Free text; may contain newlines.
|
|
849
|
+
*/
|
|
850
|
+
description?: string | null;
|
|
760
851
|
}[];
|
|
761
852
|
/**
|
|
762
853
|
* Journey Template
|
|
@@ -775,7 +866,11 @@ declare namespace Components {
|
|
|
775
866
|
settings?: {
|
|
776
867
|
embedOptions?: {
|
|
777
868
|
mode?: "full-screen" | "inline";
|
|
778
|
-
|
|
869
|
+
/**
|
|
870
|
+
* example:
|
|
871
|
+
* de
|
|
872
|
+
*/
|
|
873
|
+
lang?: string;
|
|
779
874
|
width?: string;
|
|
780
875
|
topBar?: boolean;
|
|
781
876
|
scrollToTop?: boolean;
|
|
@@ -788,7 +883,11 @@ declare namespace Components {
|
|
|
788
883
|
designId?: string;
|
|
789
884
|
entityId?: string | null;
|
|
790
885
|
mappingsAutomationId?: string;
|
|
791
|
-
|
|
886
|
+
/**
|
|
887
|
+
* When true, the journey is created without a mapping config or automation; mappings are managed as advanced mappings on a lazily created automation.
|
|
888
|
+
*/
|
|
889
|
+
newMappings?: boolean;
|
|
890
|
+
templateId?: string | null;
|
|
792
891
|
targetedCustomer?: string;
|
|
793
892
|
description?: string | null;
|
|
794
893
|
publicToken?: string | null;
|
|
@@ -825,22 +924,47 @@ declare namespace Components {
|
|
|
825
924
|
*/
|
|
826
925
|
thirdPartyCookies?: boolean;
|
|
827
926
|
accessMode?: "PUBLIC" | "PRIVATE";
|
|
927
|
+
/**
|
|
928
|
+
* Steps after this step require an authenticated session (auth gate)
|
|
929
|
+
*/
|
|
930
|
+
authGate?: {
|
|
931
|
+
/**
|
|
932
|
+
* The step containing the Login & Registration block
|
|
933
|
+
*/
|
|
934
|
+
stepId: string;
|
|
935
|
+
};
|
|
828
936
|
/**
|
|
829
937
|
* If true, the journey shows an icon to toggle dark mode
|
|
830
938
|
*/
|
|
831
939
|
enableDarkMode?: boolean;
|
|
940
|
+
/**
|
|
941
|
+
* If true, some journey input labels are in Austrian format
|
|
942
|
+
*/
|
|
943
|
+
useAustrianLabels?: boolean;
|
|
832
944
|
isActive?: boolean;
|
|
945
|
+
savingProgress?: {
|
|
946
|
+
mode?: "auto" | "local" | "remote" | "none";
|
|
947
|
+
supportedRevision?: number;
|
|
948
|
+
};
|
|
833
949
|
};
|
|
834
950
|
validationRules?: /**
|
|
835
951
|
* References to validation rules organized by blocks and fields.
|
|
836
|
-
* Maps block IDs to either
|
|
952
|
+
* Maps block IDs to either one or more ordered rule IDs (for block-level rules)
|
|
953
|
+
* or rule references (for field-level rules).
|
|
837
954
|
*
|
|
838
955
|
* example:
|
|
839
956
|
* {
|
|
840
957
|
* "block1": "rule123",
|
|
841
|
-
* "block2":
|
|
842
|
-
* "
|
|
843
|
-
* "
|
|
958
|
+
* "block2": [
|
|
959
|
+
* "rule456",
|
|
960
|
+
* "rule789"
|
|
961
|
+
* ],
|
|
962
|
+
* "block3": {
|
|
963
|
+
* "field1": "rule101",
|
|
964
|
+
* "field2": [
|
|
965
|
+
* "rule102",
|
|
966
|
+
* "rule103"
|
|
967
|
+
* ]
|
|
844
968
|
* }
|
|
845
969
|
* }
|
|
846
970
|
*/
|
|
@@ -850,6 +974,25 @@ declare namespace Components {
|
|
|
850
974
|
*/
|
|
851
975
|
_manifest?: string /* uuid */[];
|
|
852
976
|
}
|
|
977
|
+
export interface JourneyEnvironmentResponse {
|
|
978
|
+
items: {
|
|
979
|
+
datasourceId: string;
|
|
980
|
+
type: "Text" | "Number" | "Boolean" | "Map";
|
|
981
|
+
value: string | number | boolean | EnvironmentMap;
|
|
982
|
+
}[];
|
|
983
|
+
errors: {
|
|
984
|
+
datasourceId: string;
|
|
985
|
+
code: "not_found" | "unsupported_type" | "not_set" | "invalid_value" | "incompatible_consumer";
|
|
986
|
+
}[];
|
|
987
|
+
}
|
|
988
|
+
export interface JourneyEnvironmentVariablesResponse {
|
|
989
|
+
items: {
|
|
990
|
+
key: string;
|
|
991
|
+
type: "Map";
|
|
992
|
+
value: EnvironmentMap;
|
|
993
|
+
description?: string;
|
|
994
|
+
}[];
|
|
995
|
+
}
|
|
853
996
|
export interface JourneyFeatureFlags {
|
|
854
997
|
featureFlags?: {
|
|
855
998
|
[name: string]: any;
|
|
@@ -957,17 +1100,22 @@ declare namespace Components {
|
|
|
957
1100
|
}
|
|
958
1101
|
/**
|
|
959
1102
|
* Field-level rule references within a block.
|
|
960
|
-
* Maps field names to rule IDs.
|
|
1103
|
+
* Maps field names to one or more ordered rule IDs.
|
|
961
1104
|
*
|
|
962
1105
|
* example:
|
|
963
1106
|
* {
|
|
964
1107
|
* "firstName": "rule123",
|
|
965
|
-
* "lastName":
|
|
966
|
-
*
|
|
1108
|
+
* "lastName": [
|
|
1109
|
+
* "rule456",
|
|
1110
|
+
* "rule789"
|
|
1111
|
+
* ]
|
|
967
1112
|
* }
|
|
968
1113
|
*/
|
|
969
1114
|
export interface RuleRef {
|
|
970
|
-
[name: string]: string
|
|
1115
|
+
[name: string]: string | [
|
|
1116
|
+
string,
|
|
1117
|
+
...string[]
|
|
1118
|
+
];
|
|
971
1119
|
}
|
|
972
1120
|
export interface S3Reference {
|
|
973
1121
|
/**
|
|
@@ -1181,27 +1329,40 @@ declare namespace Components {
|
|
|
1181
1329
|
}
|
|
1182
1330
|
/**
|
|
1183
1331
|
* References to validation rules organized by blocks and fields.
|
|
1184
|
-
* Maps block IDs to either
|
|
1332
|
+
* Maps block IDs to either one or more ordered rule IDs (for block-level rules)
|
|
1333
|
+
* or rule references (for field-level rules).
|
|
1185
1334
|
*
|
|
1186
1335
|
* example:
|
|
1187
1336
|
* {
|
|
1188
1337
|
* "block1": "rule123",
|
|
1189
|
-
* "block2":
|
|
1190
|
-
* "
|
|
1191
|
-
* "
|
|
1338
|
+
* "block2": [
|
|
1339
|
+
* "rule456",
|
|
1340
|
+
* "rule789"
|
|
1341
|
+
* ],
|
|
1342
|
+
* "block3": {
|
|
1343
|
+
* "field1": "rule101",
|
|
1344
|
+
* "field2": [
|
|
1345
|
+
* "rule102",
|
|
1346
|
+
* "rule103"
|
|
1347
|
+
* ]
|
|
1192
1348
|
* }
|
|
1193
1349
|
* }
|
|
1194
1350
|
*/
|
|
1195
1351
|
export interface ValidationRuleRef {
|
|
1196
|
-
[name: string]: string |
|
|
1352
|
+
[name: string]: string | [
|
|
1353
|
+
string,
|
|
1354
|
+
...string[]
|
|
1355
|
+
] | /**
|
|
1197
1356
|
* Field-level rule references within a block.
|
|
1198
|
-
* Maps field names to rule IDs.
|
|
1357
|
+
* Maps field names to one or more ordered rule IDs.
|
|
1199
1358
|
*
|
|
1200
1359
|
* example:
|
|
1201
1360
|
* {
|
|
1202
1361
|
* "firstName": "rule123",
|
|
1203
|
-
* "lastName":
|
|
1204
|
-
*
|
|
1362
|
+
* "lastName": [
|
|
1363
|
+
* "rule456",
|
|
1364
|
+
* "rule789"
|
|
1365
|
+
* ]
|
|
1205
1366
|
* }
|
|
1206
1367
|
*/
|
|
1207
1368
|
RuleRef;
|
|
@@ -1326,7 +1487,320 @@ declare namespace Paths {
|
|
|
1326
1487
|
orgId?: Parameters.OrgId;
|
|
1327
1488
|
}
|
|
1328
1489
|
namespace Responses {
|
|
1329
|
-
|
|
1490
|
+
/**
|
|
1491
|
+
* Journeys read from the API always carry an explicit `settings.isActive`. The flag remains optional in request bodies.
|
|
1492
|
+
*
|
|
1493
|
+
*/
|
|
1494
|
+
export interface $200 {
|
|
1495
|
+
[name: string]: any;
|
|
1496
|
+
journeyId?: string;
|
|
1497
|
+
organizationId: string;
|
|
1498
|
+
brandId?: string;
|
|
1499
|
+
name: string;
|
|
1500
|
+
steps: {
|
|
1501
|
+
showStepName?: boolean | null;
|
|
1502
|
+
title?: string | null;
|
|
1503
|
+
subTitle?: string | null;
|
|
1504
|
+
showStepSubtitle?: boolean | null;
|
|
1505
|
+
showStepper?: boolean | null;
|
|
1506
|
+
showStepperLabels?: boolean | null;
|
|
1507
|
+
stepperType?: "numbers" | "progress bar";
|
|
1508
|
+
hideNextButton?: boolean | null;
|
|
1509
|
+
name: string;
|
|
1510
|
+
stepId?: string;
|
|
1511
|
+
schema: any;
|
|
1512
|
+
uischema: any;
|
|
1513
|
+
maxWidth?: "small" | "medium" | "large" | "extra large";
|
|
1514
|
+
}[];
|
|
1515
|
+
design?: {
|
|
1516
|
+
logoUrl?: string | null;
|
|
1517
|
+
theme?: {
|
|
1518
|
+
[name: string]: any;
|
|
1519
|
+
};
|
|
1520
|
+
designTokens?: {
|
|
1521
|
+
[key: string]: any;
|
|
1522
|
+
};
|
|
1523
|
+
};
|
|
1524
|
+
rules?: {
|
|
1525
|
+
type: "inject" | "injectWithKey";
|
|
1526
|
+
sourceType: "journey" | "step" | "block";
|
|
1527
|
+
source: string;
|
|
1528
|
+
target: string;
|
|
1529
|
+
}[];
|
|
1530
|
+
logics?: {
|
|
1531
|
+
autoGeneratedId?: string;
|
|
1532
|
+
conditions: string[];
|
|
1533
|
+
actions: string[];
|
|
1534
|
+
}[];
|
|
1535
|
+
logicsV4?: {
|
|
1536
|
+
[name: string]: {
|
|
1537
|
+
/**
|
|
1538
|
+
* Unique identifier for logic. Use uuidv7
|
|
1539
|
+
*/
|
|
1540
|
+
id?: string; // uuid
|
|
1541
|
+
/**
|
|
1542
|
+
* If true, logic can't be manipulated by the configuring user
|
|
1543
|
+
*/
|
|
1544
|
+
protected?: boolean;
|
|
1545
|
+
/**
|
|
1546
|
+
* Indicates which action to take in case logic evaluates to true
|
|
1547
|
+
*/
|
|
1548
|
+
action?: string;
|
|
1549
|
+
/**
|
|
1550
|
+
* Indicates when the logic should be evaluated
|
|
1551
|
+
*/
|
|
1552
|
+
triggeredOn?: string;
|
|
1553
|
+
conditions?: {
|
|
1554
|
+
/**
|
|
1555
|
+
* Operator to be applied between the fact value and the value
|
|
1556
|
+
*/
|
|
1557
|
+
operator?: string;
|
|
1558
|
+
/**
|
|
1559
|
+
* If operator is a custom function, this needs to be provided
|
|
1560
|
+
*/
|
|
1561
|
+
functionName?: string;
|
|
1562
|
+
fact?: {
|
|
1563
|
+
/**
|
|
1564
|
+
* Unique identifier for a fact
|
|
1565
|
+
*/
|
|
1566
|
+
id?: string; // uuid
|
|
1567
|
+
/**
|
|
1568
|
+
* Indicates reference type (block or context parameter)
|
|
1569
|
+
*/
|
|
1570
|
+
referenceType?: string;
|
|
1571
|
+
/**
|
|
1572
|
+
* Id of the reference
|
|
1573
|
+
*/
|
|
1574
|
+
referenceId?: string;
|
|
1575
|
+
/**
|
|
1576
|
+
* Path to a property. Used if only part of the value is needed
|
|
1577
|
+
*/
|
|
1578
|
+
path?: string;
|
|
1579
|
+
/**
|
|
1580
|
+
* If path is a reference, indicates the intention of it
|
|
1581
|
+
*/
|
|
1582
|
+
meaning?: string;
|
|
1583
|
+
};
|
|
1584
|
+
value?: string | number | boolean | {
|
|
1585
|
+
[key: string]: any;
|
|
1586
|
+
} | any[];
|
|
1587
|
+
args?: {
|
|
1588
|
+
[key: string]: any;
|
|
1589
|
+
};
|
|
1590
|
+
}[][];
|
|
1591
|
+
/**
|
|
1592
|
+
* Logic specific settings. Will vary by type of logic
|
|
1593
|
+
*/
|
|
1594
|
+
settings?: {
|
|
1595
|
+
[key: string]: any;
|
|
1596
|
+
};
|
|
1597
|
+
};
|
|
1598
|
+
};
|
|
1599
|
+
contextSchema?: {
|
|
1600
|
+
/**
|
|
1601
|
+
* Unique identifier for the context schema item
|
|
1602
|
+
*/
|
|
1603
|
+
id?: string; // uuid
|
|
1604
|
+
/**
|
|
1605
|
+
* Type of the parameter. It could be either an entity slug, or a text
|
|
1606
|
+
*/
|
|
1607
|
+
type: string;
|
|
1608
|
+
/**
|
|
1609
|
+
* Expected key to be received in the context
|
|
1610
|
+
*/
|
|
1611
|
+
paramKey: string;
|
|
1612
|
+
/**
|
|
1613
|
+
* Indicates if a value is expected to be provided
|
|
1614
|
+
*/
|
|
1615
|
+
isRequired?: boolean;
|
|
1616
|
+
/**
|
|
1617
|
+
* If type is not text, we can instruct the journey to fetch the entity id we receive as value
|
|
1618
|
+
*/
|
|
1619
|
+
shouldLoadEntity?: boolean;
|
|
1620
|
+
/**
|
|
1621
|
+
* Human-readable note describing the parameter's purpose. Free text; may contain newlines.
|
|
1622
|
+
*/
|
|
1623
|
+
description?: string | null;
|
|
1624
|
+
}[];
|
|
1625
|
+
/**
|
|
1626
|
+
* Journey Template
|
|
1627
|
+
* example:
|
|
1628
|
+
* Sales template (Premium)
|
|
1629
|
+
*/
|
|
1630
|
+
journey_type?: string;
|
|
1631
|
+
/**
|
|
1632
|
+
* If true, journey is displayed in read-only mode
|
|
1633
|
+
*/
|
|
1634
|
+
protected?: boolean;
|
|
1635
|
+
/**
|
|
1636
|
+
* Whitelist of paths that remain editable when the journey is protected. Supports wildcard patterns (e.g. steps/*/blocks/**).
|
|
1637
|
+
*/
|
|
1638
|
+
protectedEditable?: string[];
|
|
1639
|
+
settings: {
|
|
1640
|
+
embedOptions?: {
|
|
1641
|
+
mode?: "full-screen" | "inline";
|
|
1642
|
+
/**
|
|
1643
|
+
* example:
|
|
1644
|
+
* de
|
|
1645
|
+
*/
|
|
1646
|
+
lang?: string;
|
|
1647
|
+
width?: string;
|
|
1648
|
+
topBar?: boolean;
|
|
1649
|
+
scrollToTop?: boolean;
|
|
1650
|
+
button?: {
|
|
1651
|
+
text?: string | null;
|
|
1652
|
+
align?: "left" | "center" | "right";
|
|
1653
|
+
};
|
|
1654
|
+
};
|
|
1655
|
+
safeModeAutomation?: boolean;
|
|
1656
|
+
/**
|
|
1657
|
+
* 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.
|
|
1658
|
+
*/
|
|
1659
|
+
canary?: boolean;
|
|
1660
|
+
designId: string;
|
|
1661
|
+
templateId?: string | null;
|
|
1662
|
+
entityId?: string | null;
|
|
1663
|
+
mappingsAutomationId?: string;
|
|
1664
|
+
/**
|
|
1665
|
+
* When true, the journey is created without a mapping config or automation; mappings are managed as advanced mappings on a lazily created automation.
|
|
1666
|
+
*/
|
|
1667
|
+
newMappings?: boolean;
|
|
1668
|
+
targetedCustomer?: string;
|
|
1669
|
+
description?: string | null;
|
|
1670
|
+
organizationSettings?: {
|
|
1671
|
+
[name: string]: boolean;
|
|
1672
|
+
} | null;
|
|
1673
|
+
publicToken?: string | null;
|
|
1674
|
+
runtimeEntities?: ("ORDER" | "OPPORTUNITY")[];
|
|
1675
|
+
filePurposes?: string[];
|
|
1676
|
+
entityTags?: string[];
|
|
1677
|
+
/**
|
|
1678
|
+
* @deprecated Use addressSuggestionsFileId instead
|
|
1679
|
+
*/
|
|
1680
|
+
addressSuggestionsFileUrl?: string | null;
|
|
1681
|
+
addressSuggestionsFileId?: string | null;
|
|
1682
|
+
/**
|
|
1683
|
+
* Country code for address format (e.g. DE, AT, CH, LU)
|
|
1684
|
+
*/
|
|
1685
|
+
addressSuggestionsCountryCode?: string | null;
|
|
1686
|
+
/**
|
|
1687
|
+
* Whether address auto-complete is enabled
|
|
1688
|
+
*/
|
|
1689
|
+
addressSuggestionsEnableAutoComplete?: boolean;
|
|
1690
|
+
/**
|
|
1691
|
+
* Sources for address auto-complete (e.g. deutschePostService, customAddressesFile)
|
|
1692
|
+
*/
|
|
1693
|
+
addressSuggestionsSource?: string[];
|
|
1694
|
+
/**
|
|
1695
|
+
* Whether free text input is allowed when auto-complete is on
|
|
1696
|
+
*/
|
|
1697
|
+
addressSuggestionsEnableFreeText?: boolean;
|
|
1698
|
+
/**
|
|
1699
|
+
* This property is deprecated and will be removed in a future version
|
|
1700
|
+
*/
|
|
1701
|
+
useNewDesign?: boolean;
|
|
1702
|
+
/**
|
|
1703
|
+
* If true, some journey input labels are in Austrian format
|
|
1704
|
+
*/
|
|
1705
|
+
useAustrianLabels?: boolean;
|
|
1706
|
+
/**
|
|
1707
|
+
* If true, the journey shows an icon to toggle dark mode
|
|
1708
|
+
*/
|
|
1709
|
+
enableDarkMode?: boolean;
|
|
1710
|
+
accessMode?: "PUBLIC" | "PRIVATE";
|
|
1711
|
+
/**
|
|
1712
|
+
* Steps after this step require an authenticated session (auth gate)
|
|
1713
|
+
*/
|
|
1714
|
+
authGate?: {
|
|
1715
|
+
/**
|
|
1716
|
+
* The step containing the Login & Registration block
|
|
1717
|
+
*/
|
|
1718
|
+
stepId: string;
|
|
1719
|
+
};
|
|
1720
|
+
isPublished?: boolean;
|
|
1721
|
+
status?: string;
|
|
1722
|
+
/**
|
|
1723
|
+
* Whether the journey is active (accessible to end customers)
|
|
1724
|
+
*/
|
|
1725
|
+
isActive: boolean;
|
|
1726
|
+
savingProgress?: {
|
|
1727
|
+
mode?: "auto" | "local" | "remote" | "none";
|
|
1728
|
+
supportedRevision?: number;
|
|
1729
|
+
};
|
|
1730
|
+
/**
|
|
1731
|
+
* If false, third-party cookies are disabled to comply with GDPR regulations without asking for consent.
|
|
1732
|
+
*/
|
|
1733
|
+
thirdPartyCookies?: boolean;
|
|
1734
|
+
};
|
|
1735
|
+
validationRules?: /**
|
|
1736
|
+
* References to validation rules organized by blocks and fields.
|
|
1737
|
+
* Maps block IDs to either one or more ordered rule IDs (for block-level rules)
|
|
1738
|
+
* or rule references (for field-level rules).
|
|
1739
|
+
*
|
|
1740
|
+
* example:
|
|
1741
|
+
* {
|
|
1742
|
+
* "block1": "rule123",
|
|
1743
|
+
* "block2": [
|
|
1744
|
+
* "rule456",
|
|
1745
|
+
* "rule789"
|
|
1746
|
+
* ],
|
|
1747
|
+
* "block3": {
|
|
1748
|
+
* "field1": "rule101",
|
|
1749
|
+
* "field2": [
|
|
1750
|
+
* "rule102",
|
|
1751
|
+
* "rule103"
|
|
1752
|
+
* ]
|
|
1753
|
+
* }
|
|
1754
|
+
* }
|
|
1755
|
+
*/
|
|
1756
|
+
Components.Schemas.ValidationRuleRef;
|
|
1757
|
+
/**
|
|
1758
|
+
* Manifest/Blueprint ID used to create/update the entity
|
|
1759
|
+
*/
|
|
1760
|
+
_manifest?: string /* uuid */[];
|
|
1761
|
+
createdBy?: string;
|
|
1762
|
+
updatedBy?: string | null;
|
|
1763
|
+
/**
|
|
1764
|
+
* If passed with value of null, the API won't modify the lastModifiedAt field on updating the journey
|
|
1765
|
+
*/
|
|
1766
|
+
__lastModifiedAt?: string | null;
|
|
1767
|
+
createdAt: string;
|
|
1768
|
+
lastModifiedAt: string;
|
|
1769
|
+
deletedAt?: string;
|
|
1770
|
+
version: number;
|
|
1771
|
+
revisions: number;
|
|
1772
|
+
featureFlags?: {
|
|
1773
|
+
[name: string]: any;
|
|
1774
|
+
};
|
|
1775
|
+
}
|
|
1776
|
+
}
|
|
1777
|
+
}
|
|
1778
|
+
namespace GetJourneyEnvironment {
|
|
1779
|
+
namespace Parameters {
|
|
1780
|
+
export type Id = string; // uuid
|
|
1781
|
+
}
|
|
1782
|
+
export interface PathParameters {
|
|
1783
|
+
id: Parameters.Id /* uuid */;
|
|
1784
|
+
}
|
|
1785
|
+
namespace Responses {
|
|
1786
|
+
export type $200 = Components.Schemas.JourneyEnvironmentResponse;
|
|
1787
|
+
export interface $401 {
|
|
1788
|
+
}
|
|
1789
|
+
export interface $403 {
|
|
1790
|
+
}
|
|
1791
|
+
export interface $502 {
|
|
1792
|
+
}
|
|
1793
|
+
}
|
|
1794
|
+
}
|
|
1795
|
+
namespace GetJourneyEnvironmentVariables {
|
|
1796
|
+
namespace Responses {
|
|
1797
|
+
export type $200 = Components.Schemas.JourneyEnvironmentVariablesResponse;
|
|
1798
|
+
export interface $401 {
|
|
1799
|
+
}
|
|
1800
|
+
export interface $403 {
|
|
1801
|
+
}
|
|
1802
|
+
export interface $502 {
|
|
1803
|
+
}
|
|
1330
1804
|
}
|
|
1331
1805
|
}
|
|
1332
1806
|
namespace GetJourneyProducts {
|
|
@@ -1380,7 +1854,267 @@ declare namespace Paths {
|
|
|
1380
1854
|
version?: Parameters.Version;
|
|
1381
1855
|
}
|
|
1382
1856
|
namespace Responses {
|
|
1383
|
-
|
|
1857
|
+
/**
|
|
1858
|
+
* Journeys read from the API always carry an explicit `settings.isActive`. The flag remains optional in request bodies.
|
|
1859
|
+
*
|
|
1860
|
+
*/
|
|
1861
|
+
export interface $200 {
|
|
1862
|
+
journeyId?: string;
|
|
1863
|
+
brandId?: string;
|
|
1864
|
+
name: string;
|
|
1865
|
+
steps: {
|
|
1866
|
+
showStepName?: boolean | null;
|
|
1867
|
+
title?: string | null;
|
|
1868
|
+
subTitle?: string | null;
|
|
1869
|
+
showStepSubtitle?: boolean | null;
|
|
1870
|
+
showStepper?: boolean | null;
|
|
1871
|
+
showStepperLabels?: boolean | null;
|
|
1872
|
+
stepperType?: "numbers" | "progress bar";
|
|
1873
|
+
hideNextButton?: boolean | null;
|
|
1874
|
+
name: string;
|
|
1875
|
+
stepId?: string;
|
|
1876
|
+
schema: any;
|
|
1877
|
+
uischema: any;
|
|
1878
|
+
maxWidth?: "small" | "medium" | "large" | "extra large";
|
|
1879
|
+
}[];
|
|
1880
|
+
design?: {
|
|
1881
|
+
logoUrl?: string | null;
|
|
1882
|
+
theme?: {
|
|
1883
|
+
[name: string]: any;
|
|
1884
|
+
};
|
|
1885
|
+
designTokens?: {
|
|
1886
|
+
[key: string]: any;
|
|
1887
|
+
};
|
|
1888
|
+
};
|
|
1889
|
+
rules?: {
|
|
1890
|
+
type: "inject" | "injectWithKey";
|
|
1891
|
+
sourceType: "journey" | "step" | "block";
|
|
1892
|
+
source: string;
|
|
1893
|
+
target: string;
|
|
1894
|
+
}[];
|
|
1895
|
+
logics?: {
|
|
1896
|
+
autoGeneratedId?: string;
|
|
1897
|
+
conditions: string[];
|
|
1898
|
+
actions: string[];
|
|
1899
|
+
}[];
|
|
1900
|
+
logicsV4?: {
|
|
1901
|
+
[name: string]: {
|
|
1902
|
+
/**
|
|
1903
|
+
* Unique identifier for logic. Use uuidv7
|
|
1904
|
+
*/
|
|
1905
|
+
id?: string; // uuid
|
|
1906
|
+
/**
|
|
1907
|
+
* If true, logic can't be manipulated by the configuring user
|
|
1908
|
+
*/
|
|
1909
|
+
protected?: boolean;
|
|
1910
|
+
/**
|
|
1911
|
+
* Indicates which action to take in case logic evaluates to true
|
|
1912
|
+
*/
|
|
1913
|
+
action?: string;
|
|
1914
|
+
/**
|
|
1915
|
+
* Indicates when the logic should be evaluated
|
|
1916
|
+
*/
|
|
1917
|
+
triggeredOn?: string;
|
|
1918
|
+
conditions?: {
|
|
1919
|
+
/**
|
|
1920
|
+
* Operator to be applied between the fact value and the value
|
|
1921
|
+
*/
|
|
1922
|
+
operator?: string;
|
|
1923
|
+
/**
|
|
1924
|
+
* If operator is a custom function, this needs to be provided
|
|
1925
|
+
*/
|
|
1926
|
+
functionName?: string;
|
|
1927
|
+
fact?: {
|
|
1928
|
+
/**
|
|
1929
|
+
* Unique identifier for a fact
|
|
1930
|
+
*/
|
|
1931
|
+
id?: string; // uuid
|
|
1932
|
+
/**
|
|
1933
|
+
* Indicates reference type (block or context parameter)
|
|
1934
|
+
*/
|
|
1935
|
+
referenceType?: string;
|
|
1936
|
+
/**
|
|
1937
|
+
* Id of the reference
|
|
1938
|
+
*/
|
|
1939
|
+
referenceId?: string;
|
|
1940
|
+
/**
|
|
1941
|
+
* Path to a property. Used if only part of the value is needed
|
|
1942
|
+
*/
|
|
1943
|
+
path?: string;
|
|
1944
|
+
/**
|
|
1945
|
+
* If path is a reference, indicates the intention of it
|
|
1946
|
+
*/
|
|
1947
|
+
meaning?: string;
|
|
1948
|
+
};
|
|
1949
|
+
value?: string | number | boolean | {
|
|
1950
|
+
[key: string]: any;
|
|
1951
|
+
} | any[];
|
|
1952
|
+
args?: {
|
|
1953
|
+
[key: string]: any;
|
|
1954
|
+
};
|
|
1955
|
+
}[][];
|
|
1956
|
+
/**
|
|
1957
|
+
* Logic specific settings. Will vary by type of logic
|
|
1958
|
+
*/
|
|
1959
|
+
settings?: {
|
|
1960
|
+
[key: string]: any;
|
|
1961
|
+
};
|
|
1962
|
+
};
|
|
1963
|
+
};
|
|
1964
|
+
contextSchema?: {
|
|
1965
|
+
/**
|
|
1966
|
+
* Unique identifier for the context schema item
|
|
1967
|
+
*/
|
|
1968
|
+
id?: string; // uuid
|
|
1969
|
+
/**
|
|
1970
|
+
* Type of the parameter. It could be either an entity slug, or a text
|
|
1971
|
+
*/
|
|
1972
|
+
type: string;
|
|
1973
|
+
/**
|
|
1974
|
+
* Expected key to be received in the context
|
|
1975
|
+
*/
|
|
1976
|
+
paramKey: string;
|
|
1977
|
+
/**
|
|
1978
|
+
* Indicates if a value is expected to be provided
|
|
1979
|
+
*/
|
|
1980
|
+
isRequired?: boolean;
|
|
1981
|
+
/**
|
|
1982
|
+
* If type is not text, we can instruct the journey to fetch the entity id we receive as value
|
|
1983
|
+
*/
|
|
1984
|
+
shouldLoadEntity?: boolean;
|
|
1985
|
+
/**
|
|
1986
|
+
* Human-readable note describing the parameter's purpose. Free text; may contain newlines.
|
|
1987
|
+
*/
|
|
1988
|
+
description?: string | null;
|
|
1989
|
+
}[];
|
|
1990
|
+
/**
|
|
1991
|
+
* Journey Template
|
|
1992
|
+
* example:
|
|
1993
|
+
* Sales template (Premium)
|
|
1994
|
+
*/
|
|
1995
|
+
journey_type?: string;
|
|
1996
|
+
/**
|
|
1997
|
+
* If true, journey is displayed in read-only mode
|
|
1998
|
+
*/
|
|
1999
|
+
protected?: boolean;
|
|
2000
|
+
/**
|
|
2001
|
+
* Whitelist of paths that remain editable when the journey is protected. Supports wildcard patterns (e.g. steps/*/blocks/**).
|
|
2002
|
+
*/
|
|
2003
|
+
protectedEditable?: string[];
|
|
2004
|
+
settings: {
|
|
2005
|
+
embedOptions?: {
|
|
2006
|
+
mode?: "full-screen" | "inline";
|
|
2007
|
+
/**
|
|
2008
|
+
* example:
|
|
2009
|
+
* de
|
|
2010
|
+
*/
|
|
2011
|
+
lang?: string;
|
|
2012
|
+
width?: string;
|
|
2013
|
+
topBar?: boolean;
|
|
2014
|
+
scrollToTop?: boolean;
|
|
2015
|
+
button?: {
|
|
2016
|
+
text?: string | null;
|
|
2017
|
+
align?: "left" | "center" | "right";
|
|
2018
|
+
};
|
|
2019
|
+
};
|
|
2020
|
+
safeModeAutomation?: boolean;
|
|
2021
|
+
designId?: string;
|
|
2022
|
+
entityId?: string | null;
|
|
2023
|
+
mappingsAutomationId?: string;
|
|
2024
|
+
/**
|
|
2025
|
+
* When true, the journey is created without a mapping config or automation; mappings are managed as advanced mappings on a lazily created automation.
|
|
2026
|
+
*/
|
|
2027
|
+
newMappings?: boolean;
|
|
2028
|
+
templateId?: string | null;
|
|
2029
|
+
targetedCustomer?: string;
|
|
2030
|
+
description?: string | null;
|
|
2031
|
+
publicToken?: string | null;
|
|
2032
|
+
runtimeEntities?: ("ORDER" | "OPPORTUNITY")[];
|
|
2033
|
+
filePurposes?: string[];
|
|
2034
|
+
entityTags?: string[];
|
|
2035
|
+
/**
|
|
2036
|
+
* @deprecated Use addressSuggestionsFileId instead
|
|
2037
|
+
*/
|
|
2038
|
+
addressSuggestionsFileUrl?: string | null;
|
|
2039
|
+
addressSuggestionsFileId?: string | null;
|
|
2040
|
+
/**
|
|
2041
|
+
* Country code for address format (e.g. DE, AT, CH, LU)
|
|
2042
|
+
*/
|
|
2043
|
+
addressSuggestionsCountryCode?: string | null;
|
|
2044
|
+
/**
|
|
2045
|
+
* Whether address auto-complete is enabled
|
|
2046
|
+
*/
|
|
2047
|
+
addressSuggestionsEnableAutoComplete?: boolean;
|
|
2048
|
+
/**
|
|
2049
|
+
* Sources for address auto-complete (e.g. deutschePostService, customAddressesFile)
|
|
2050
|
+
*/
|
|
2051
|
+
addressSuggestionsSource?: string[];
|
|
2052
|
+
/**
|
|
2053
|
+
* Whether free text input is allowed when auto-complete is on
|
|
2054
|
+
*/
|
|
2055
|
+
addressSuggestionsEnableFreeText?: boolean;
|
|
2056
|
+
/**
|
|
2057
|
+
* This property is deprecated and will be removed in a future version
|
|
2058
|
+
*/
|
|
2059
|
+
useNewDesign?: boolean;
|
|
2060
|
+
/**
|
|
2061
|
+
* If false, third-party cookies are disabled to comply with GDPR regulations without asking for consent.
|
|
2062
|
+
*/
|
|
2063
|
+
thirdPartyCookies?: boolean;
|
|
2064
|
+
accessMode?: "PUBLIC" | "PRIVATE";
|
|
2065
|
+
/**
|
|
2066
|
+
* Steps after this step require an authenticated session (auth gate)
|
|
2067
|
+
*/
|
|
2068
|
+
authGate?: {
|
|
2069
|
+
/**
|
|
2070
|
+
* The step containing the Login & Registration block
|
|
2071
|
+
*/
|
|
2072
|
+
stepId: string;
|
|
2073
|
+
};
|
|
2074
|
+
/**
|
|
2075
|
+
* If true, the journey shows an icon to toggle dark mode
|
|
2076
|
+
*/
|
|
2077
|
+
enableDarkMode?: boolean;
|
|
2078
|
+
/**
|
|
2079
|
+
* If true, some journey input labels are in Austrian format
|
|
2080
|
+
*/
|
|
2081
|
+
useAustrianLabels?: boolean;
|
|
2082
|
+
/**
|
|
2083
|
+
* Whether the journey is active (accessible to end customers)
|
|
2084
|
+
*/
|
|
2085
|
+
isActive: boolean;
|
|
2086
|
+
savingProgress?: {
|
|
2087
|
+
mode?: "auto" | "local" | "remote" | "none";
|
|
2088
|
+
supportedRevision?: number;
|
|
2089
|
+
};
|
|
2090
|
+
};
|
|
2091
|
+
validationRules?: /**
|
|
2092
|
+
* References to validation rules organized by blocks and fields.
|
|
2093
|
+
* Maps block IDs to either one or more ordered rule IDs (for block-level rules)
|
|
2094
|
+
* or rule references (for field-level rules).
|
|
2095
|
+
*
|
|
2096
|
+
* example:
|
|
2097
|
+
* {
|
|
2098
|
+
* "block1": "rule123",
|
|
2099
|
+
* "block2": [
|
|
2100
|
+
* "rule456",
|
|
2101
|
+
* "rule789"
|
|
2102
|
+
* ],
|
|
2103
|
+
* "block3": {
|
|
2104
|
+
* "field1": "rule101",
|
|
2105
|
+
* "field2": [
|
|
2106
|
+
* "rule102",
|
|
2107
|
+
* "rule103"
|
|
2108
|
+
* ]
|
|
2109
|
+
* }
|
|
2110
|
+
* }
|
|
2111
|
+
*/
|
|
2112
|
+
Components.Schemas.ValidationRuleRef;
|
|
2113
|
+
/**
|
|
2114
|
+
* Manifest/Blueprint ID used to create/update the entity
|
|
2115
|
+
*/
|
|
2116
|
+
_manifest?: string /* uuid */[];
|
|
2117
|
+
}
|
|
1384
2118
|
}
|
|
1385
2119
|
}
|
|
1386
2120
|
namespace GetJourneysByOrgId {
|
|
@@ -1588,6 +2322,26 @@ export interface OperationMethods {
|
|
|
1588
2322
|
data?: any,
|
|
1589
2323
|
config?: AxiosRequestConfig
|
|
1590
2324
|
): OperationResponse<any>
|
|
2325
|
+
/**
|
|
2326
|
+
* getJourneyEnvironment - getJourneyEnvironment
|
|
2327
|
+
*
|
|
2328
|
+
* Resolve the environment variables referenced by this journey. Only browser-safe value types are returned.
|
|
2329
|
+
*/
|
|
2330
|
+
'getJourneyEnvironment'(
|
|
2331
|
+
parameters?: Parameters<Paths.GetJourneyEnvironment.PathParameters> | null,
|
|
2332
|
+
data?: any,
|
|
2333
|
+
config?: AxiosRequestConfig
|
|
2334
|
+
): OperationResponse<Paths.GetJourneyEnvironment.Responses.$200>
|
|
2335
|
+
/**
|
|
2336
|
+
* getJourneyEnvironmentVariables - getJourneyEnvironmentVariables
|
|
2337
|
+
*
|
|
2338
|
+
* List the organization's environment variables that a journey block may use as an options source. Only Map variables that currently hold a valid value are returned. Intended for the journey builder's authoring UI; requires a journey authoring token, not an environments token.
|
|
2339
|
+
*/
|
|
2340
|
+
'getJourneyEnvironmentVariables'(
|
|
2341
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2342
|
+
data?: any,
|
|
2343
|
+
config?: AxiosRequestConfig
|
|
2344
|
+
): OperationResponse<Paths.GetJourneyEnvironmentVariables.Responses.$200>
|
|
1591
2345
|
/**
|
|
1592
2346
|
* getJourneyProducts - getJourneyProducts
|
|
1593
2347
|
*
|
|
@@ -1766,6 +2520,30 @@ export interface PathsDictionary {
|
|
|
1766
2520
|
config?: AxiosRequestConfig
|
|
1767
2521
|
): OperationResponse<any>
|
|
1768
2522
|
}
|
|
2523
|
+
['/v1/journey/configuration/{id}/environment']: {
|
|
2524
|
+
/**
|
|
2525
|
+
* getJourneyEnvironment - getJourneyEnvironment
|
|
2526
|
+
*
|
|
2527
|
+
* Resolve the environment variables referenced by this journey. Only browser-safe value types are returned.
|
|
2528
|
+
*/
|
|
2529
|
+
'get'(
|
|
2530
|
+
parameters?: Parameters<Paths.GetJourneyEnvironment.PathParameters> | null,
|
|
2531
|
+
data?: any,
|
|
2532
|
+
config?: AxiosRequestConfig
|
|
2533
|
+
): OperationResponse<Paths.GetJourneyEnvironment.Responses.$200>
|
|
2534
|
+
}
|
|
2535
|
+
['/v1/journey/environment-variables']: {
|
|
2536
|
+
/**
|
|
2537
|
+
* getJourneyEnvironmentVariables - getJourneyEnvironmentVariables
|
|
2538
|
+
*
|
|
2539
|
+
* List the organization's environment variables that a journey block may use as an options source. Only Map variables that currently hold a valid value are returned. Intended for the journey builder's authoring UI; requires a journey authoring token, not an environments token.
|
|
2540
|
+
*/
|
|
2541
|
+
'get'(
|
|
2542
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2543
|
+
data?: any,
|
|
2544
|
+
config?: AxiosRequestConfig
|
|
2545
|
+
): OperationResponse<Paths.GetJourneyEnvironmentVariables.Responses.$200>
|
|
2546
|
+
}
|
|
1769
2547
|
['/v1/journey/products/{id}']: {
|
|
1770
2548
|
/**
|
|
1771
2549
|
* getJourneyProducts - getJourneyProducts
|
|
@@ -1929,14 +2707,19 @@ export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
|
1929
2707
|
|
|
1930
2708
|
|
|
1931
2709
|
export type ButtonOption = Components.Schemas.ButtonOption;
|
|
2710
|
+
export type EnvironmentMap = Components.Schemas.EnvironmentMap;
|
|
2711
|
+
export type EnvironmentMapEntry = Components.Schemas.EnvironmentMapEntry;
|
|
1932
2712
|
export type GenerateDocumentRequest = Components.Schemas.GenerateDocumentRequest;
|
|
1933
2713
|
export type GenerateDocumentResponse = Components.Schemas.GenerateDocumentResponse;
|
|
1934
2714
|
export type GetJourneysResponse = Components.Schemas.GetJourneysResponse;
|
|
1935
2715
|
export type GetSettingsForJourney = Components.Schemas.GetSettingsForJourney;
|
|
1936
2716
|
export type Journey = Components.Schemas.Journey;
|
|
2717
|
+
export type JourneyActivationGuarantee = Components.Schemas.JourneyActivationGuarantee;
|
|
1937
2718
|
export type JourneyAuditInfo = Components.Schemas.JourneyAuditInfo;
|
|
1938
2719
|
export type JourneyCreationRequest = Components.Schemas.JourneyCreationRequest;
|
|
1939
2720
|
export type JourneyCreationRequestV2 = Components.Schemas.JourneyCreationRequestV2;
|
|
2721
|
+
export type JourneyEnvironmentResponse = Components.Schemas.JourneyEnvironmentResponse;
|
|
2722
|
+
export type JourneyEnvironmentVariablesResponse = Components.Schemas.JourneyEnvironmentVariablesResponse;
|
|
1940
2723
|
export type JourneyFeatureFlags = Components.Schemas.JourneyFeatureFlags;
|
|
1941
2724
|
export type JourneyProductsResponse = Components.Schemas.JourneyProductsResponse;
|
|
1942
2725
|
export type JourneyResponse = Components.Schemas.JourneyResponse;
|
package/package.json
CHANGED
|
@@ -1,9 +1,19 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@epilot/journey-client",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.6.0-alpha.1",
|
|
4
4
|
"description": "API Client for epilot Journey API",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
7
|
+
"scripts": {
|
|
8
|
+
"test": "vitest",
|
|
9
|
+
"typescript": "tsc",
|
|
10
|
+
"bundle-definition": "webpack",
|
|
11
|
+
"openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/journey-config.yaml",
|
|
12
|
+
"typegen": "openapi typegen src/openapi.json --client > src/openapi.d.ts",
|
|
13
|
+
"build": "npm run openapi && npm run typegen && npm run typescript && npm run bundle-definition",
|
|
14
|
+
"eslint": "../node_modules/.bin/eslint -c ../.eslintrc.yml",
|
|
15
|
+
"prepublishOnly": "npm run build"
|
|
16
|
+
},
|
|
7
17
|
"files": [
|
|
8
18
|
"*.js",
|
|
9
19
|
"*.d.ts",
|
|
@@ -47,14 +57,5 @@
|
|
|
47
57
|
"vitest": "^1.6.0",
|
|
48
58
|
"webpack": "^5.91.0",
|
|
49
59
|
"webpack-cli": "^5.1.4"
|
|
50
|
-
},
|
|
51
|
-
"scripts": {
|
|
52
|
-
"test": "vitest",
|
|
53
|
-
"typescript": "tsc",
|
|
54
|
-
"bundle-definition": "webpack",
|
|
55
|
-
"openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/journey-config.yaml",
|
|
56
|
-
"typegen": "openapi typegen src/openapi.json --client > src/openapi.d.ts",
|
|
57
|
-
"build": "npm run openapi && npm run typegen && npm run typescript && npm run bundle-definition",
|
|
58
|
-
"eslint": "../node_modules/.bin/eslint -c ../.eslintrc.yml"
|
|
59
60
|
}
|
|
60
|
-
}
|
|
61
|
+
}
|