@epilot/journey-client 0.5.1 → 0.5.2

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/src/openapi.d.ts DELETED
@@ -1,1914 +0,0 @@
1
- /* eslint-disable */
2
-
3
- import type {
4
- OpenAPIClient,
5
- Parameters,
6
- UnknownParamsObject,
7
- OperationResponse,
8
- AxiosRequestConfig,
9
- } from 'openapi-client-axios';
10
-
11
- declare namespace Components {
12
- namespace Schemas {
13
- /**
14
- * A single button option data
15
- */
16
- export interface ButtonOption {
17
- /**
18
- * The value of the button
19
- * example:
20
- * Button Hidden Value
21
- */
22
- value?: string;
23
- /**
24
- * The label of the button
25
- * example:
26
- * Button Label
27
- */
28
- label?: string;
29
- }
30
- export interface GenerateDocumentRequest {
31
- /**
32
- * Entity id for the template being used
33
- * example:
34
- * 1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p
35
- */
36
- file_id: string;
37
- /**
38
- * Custom values for variables in the template. Takes the higher precedence than others.
39
- */
40
- context_data: {
41
- additionalProperties?: string;
42
- };
43
- /**
44
- * Language code for the document
45
- * example:
46
- * de
47
- */
48
- language?: string;
49
- }
50
- export interface GenerateDocumentResponse {
51
- job_id?: string; // uuid
52
- /**
53
- * Status of the job
54
- */
55
- job_status?: "STARTED" | "PROCESSING" | "SUCCESS" | "FAILED";
56
- /**
57
- * A message explaining the progress
58
- */
59
- message?: string;
60
- pdf_output?: {
61
- /**
62
- * Pre-signed S3 GET URL for PDF preview
63
- * example:
64
- * https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/my-template-OR-001.pdf
65
- */
66
- preview_url?: string;
67
- /**
68
- * example:
69
- * {
70
- * "s3ref": {
71
- * "bucket": "document-api-preview-prod",
72
- * "key": "preview/my-template.pdf"
73
- * }
74
- * }
75
- */
76
- output_document?: {
77
- /**
78
- * Generated document filename for PDF
79
- * example:
80
- * my-template-OR-001.pdf
81
- */
82
- filename?: string;
83
- s3ref?: S3Reference;
84
- };
85
- };
86
- docx_output?: {
87
- /**
88
- * Pre-signed S3 GET URL for DOCX preview
89
- * example:
90
- * https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/my-template-OR-001.docx
91
- */
92
- preview_url?: string;
93
- /**
94
- * example:
95
- * {
96
- * "s3ref": {
97
- * "bucket": "document-api-preview-prod",
98
- * "key": "preview/my-template.docx"
99
- * }
100
- * }
101
- */
102
- output_document?: {
103
- /**
104
- * Generated document filename for DOCX
105
- * example:
106
- * my-template-OR-001.docx
107
- */
108
- filename?: string;
109
- s3ref?: S3Reference;
110
- };
111
- };
112
- /**
113
- * List of variables and its corresponding replaced values from the document template
114
- */
115
- variable_payload?: {
116
- additionalProperties?: string;
117
- };
118
- template_settings?: /* Template Settings for document generation */ TemplateSettings;
119
- }
120
- export interface GetJourneysResponse {
121
- }
122
- export interface GetSettingsForJourney {
123
- /**
124
- * ID of an organization in epilot platform
125
- * example:
126
- * 739224
127
- */
128
- organizationId?: string;
129
- /**
130
- * The canary flag controls update frequency of epilot application: when true, customers receive continuous updates; when false, they only get updates with new version releases.
131
- * example:
132
- * true
133
- */
134
- canary?: boolean;
135
- /**
136
- * When set to false, third-party cookies and resources should be completely disabled to comply with GDPR regulations.
137
- * example:
138
- * true
139
- */
140
- thirdPartyCookies?: boolean;
141
- }
142
- export interface Journey {
143
- [name: string]: any;
144
- journeyId?: string;
145
- organizationId: string;
146
- brandId?: string;
147
- name: string;
148
- steps: {
149
- showStepName?: boolean | null;
150
- title?: string | null;
151
- subTitle?: string | null;
152
- showStepSubtitle?: boolean | null;
153
- showStepper?: boolean | null;
154
- showStepperLabels?: boolean | null;
155
- hideNextButton?: boolean | null;
156
- name: string;
157
- stepId?: string;
158
- schema: any;
159
- uischema: any;
160
- maxWidth?: "small" | "medium" | "large" | "extra large";
161
- }[];
162
- design?: {
163
- logoUrl?: string | null;
164
- theme?: {
165
- [name: string]: any;
166
- };
167
- designTokens?: {
168
- [key: string]: any;
169
- };
170
- };
171
- rules?: {
172
- type: "inject" | "injectWithKey";
173
- sourceType: "journey" | "step" | "block";
174
- source: string;
175
- target: string;
176
- }[];
177
- logics?: {
178
- autoGeneratedId?: string;
179
- conditions: string[];
180
- actions: string[];
181
- }[];
182
- logicsV4?: {
183
- [name: string]: {
184
- /**
185
- * Unique identifier for logic. Use uuidv7
186
- */
187
- id?: string; // uuid
188
- /**
189
- * If true, logic can't be manipulated by the configuring user
190
- */
191
- protected?: boolean;
192
- /**
193
- * Indicates which action to take in case logic evaluates to true
194
- */
195
- action?: string;
196
- /**
197
- * Indicates when the logic should be evaluated
198
- */
199
- triggeredOn?: string;
200
- conditions?: {
201
- /**
202
- * Operator to be applied between the fact value and the value
203
- */
204
- operator?: string;
205
- /**
206
- * If operator is a custom function, this needs to be provided
207
- */
208
- functionName?: string;
209
- fact?: {
210
- /**
211
- * Unique identifier for a fact
212
- */
213
- id?: string; // uuid
214
- /**
215
- * Indicates reference type (block or context parameter)
216
- */
217
- referenceType?: string;
218
- /**
219
- * Id of the reference
220
- */
221
- referenceId?: string;
222
- /**
223
- * Path to a property. Used if only part of the value is needed
224
- */
225
- path?: string;
226
- /**
227
- * If path is a reference, indicates the intention of it
228
- */
229
- meaning?: string;
230
- };
231
- value?: string | number | boolean | {
232
- [key: string]: any;
233
- } | any[];
234
- args?: {
235
- [key: string]: any;
236
- };
237
- }[][];
238
- /**
239
- * Logic specific settings. Will vary by type of logic
240
- */
241
- settings?: {
242
- [key: string]: any;
243
- };
244
- };
245
- };
246
- contextSchema?: {
247
- /**
248
- * Unique identifier for the context schema item
249
- */
250
- id?: string; // uuid
251
- /**
252
- * Type of the parameter. It could be either an entity slug, or a text
253
- */
254
- type: string;
255
- /**
256
- * Expected key to be received in the context
257
- */
258
- paramKey: string;
259
- /**
260
- * Indicates if a value is expected to be provided
261
- */
262
- isRequired?: boolean;
263
- /**
264
- * If type is not text, we can instruct the journey to fetch the entity id we receive as value
265
- */
266
- shouldLoadEntity?: boolean;
267
- }[];
268
- /**
269
- * Journey Template
270
- * example:
271
- * Sales template (Premium)
272
- */
273
- journey_type?: string;
274
- settings?: {
275
- embedOptions?: {
276
- mode?: "full-screen" | "inline";
277
- lang?: "de" | "en" | "fr";
278
- width?: string;
279
- topBar?: boolean;
280
- scrollToTop?: boolean;
281
- button?: {
282
- text?: string | null;
283
- align?: "left" | "center" | "right";
284
- };
285
- };
286
- safeModeAutomation?: boolean;
287
- /**
288
- * 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.
289
- */
290
- canary?: boolean;
291
- designId: string;
292
- templateId?: string;
293
- entityId?: string | null;
294
- mappingsAutomationId?: string;
295
- targetedCustomer?: string;
296
- description?: string | null;
297
- organizationSettings?: {
298
- [name: string]: boolean;
299
- } | null;
300
- publicToken?: string | null;
301
- runtimeEntities?: ("ORDER" | "OPPORTUNITY")[];
302
- filePurposes?: string[];
303
- entityTags?: string[];
304
- /**
305
- * @deprecated Use addressSuggestionsFileId instead
306
- */
307
- addressSuggestionsFileUrl?: string | null;
308
- addressSuggestionsFileId?: string | null;
309
- /**
310
- * Country code for address format (e.g. DE, AT, CH, LU)
311
- */
312
- addressSuggestionsCountryCode?: string | null;
313
- /**
314
- * Whether address auto-complete is enabled
315
- */
316
- addressSuggestionsEnableAutoComplete?: boolean;
317
- /**
318
- * Sources for address auto-complete (e.g. deutschePostService, customAddressesFile)
319
- */
320
- addressSuggestionsSource?: string[];
321
- /**
322
- * Whether free text input is allowed when auto-complete is on
323
- */
324
- addressSuggestionsEnableFreeText?: boolean;
325
- /**
326
- * This property is deprecated and will be removed in a future version
327
- */
328
- useNewDesign?: boolean;
329
- /**
330
- * If true, some journey input labels are in Austrian format
331
- */
332
- useAustrianLabels?: boolean;
333
- /**
334
- * If true, the journey shows an icon to toggle dark mode
335
- */
336
- enableDarkMode?: boolean;
337
- accessMode?: "PUBLIC" | "PRIVATE";
338
- isPublished?: boolean;
339
- status?: string;
340
- isActive?: boolean;
341
- savingProgress?: {
342
- savingMode?: "auto" | "local" | "remote" | "none";
343
- supportedVersion?: number;
344
- };
345
- /**
346
- * If false, third-party cookies are disabled to comply with GDPR regulations without asking for consent.
347
- */
348
- thirdPartyCookies?: boolean;
349
- };
350
- validationRules?: /**
351
- * References to validation rules organized by blocks and fields.
352
- * Maps block IDs to either rule IDs (for block-level rules) or rule references (for field-level rules).
353
- *
354
- * example:
355
- * {
356
- * "block1": "rule123",
357
- * "block2": {
358
- * "field1": "rule456",
359
- * "field2": "rule789"
360
- * }
361
- * }
362
- */
363
- ValidationRuleRef;
364
- createdBy?: string;
365
- updatedBy?: string | null;
366
- /**
367
- * If passed with value of null, the API won't modify the lastModifiedAt field on updating the journey
368
- */
369
- __lastModifiedAt?: string | null;
370
- createdAt: string;
371
- lastModifiedAt: string;
372
- deletedAt?: string;
373
- version: number;
374
- revisions: number;
375
- featureFlags?: {
376
- [name: string]: any;
377
- };
378
- }
379
- export interface JourneyAuditInfo {
380
- createdAt: string;
381
- lastModifiedAt: string;
382
- deletedAt?: string;
383
- version: number;
384
- revisions: number;
385
- }
386
- export interface JourneyCreationRequest {
387
- [name: string]: any;
388
- journeyId?: string;
389
- organizationId: string;
390
- brandId?: string;
391
- name: string;
392
- steps: {
393
- showStepName?: boolean | null;
394
- title?: string | null;
395
- subTitle?: string | null;
396
- showStepSubtitle?: boolean | null;
397
- showStepper?: boolean | null;
398
- showStepperLabels?: boolean | null;
399
- hideNextButton?: boolean | null;
400
- name: string;
401
- stepId?: string;
402
- schema: any;
403
- uischema: any;
404
- maxWidth?: "small" | "medium" | "large" | "extra large";
405
- }[];
406
- design?: {
407
- logoUrl?: string | null;
408
- theme?: {
409
- [name: string]: any;
410
- };
411
- designTokens?: {
412
- [key: string]: any;
413
- };
414
- };
415
- rules?: {
416
- type: "inject" | "injectWithKey";
417
- sourceType: "journey" | "step" | "block";
418
- source: string;
419
- target: string;
420
- }[];
421
- logics?: {
422
- autoGeneratedId?: string;
423
- conditions: string[];
424
- actions: string[];
425
- }[];
426
- logicsV4?: {
427
- [name: string]: {
428
- /**
429
- * Unique identifier for logic. Use uuidv7
430
- */
431
- id?: string; // uuid
432
- /**
433
- * If true, logic can't be manipulated by the configuring user
434
- */
435
- protected?: boolean;
436
- /**
437
- * Indicates which action to take in case logic evaluates to true
438
- */
439
- action?: string;
440
- /**
441
- * Indicates when the logic should be evaluated
442
- */
443
- triggeredOn?: string;
444
- conditions?: {
445
- /**
446
- * Operator to be applied between the fact value and the value
447
- */
448
- operator?: string;
449
- /**
450
- * If operator is a custom function, this needs to be provided
451
- */
452
- functionName?: string;
453
- fact?: {
454
- /**
455
- * Unique identifier for a fact
456
- */
457
- id?: string; // uuid
458
- /**
459
- * Indicates reference type (block or context parameter)
460
- */
461
- referenceType?: string;
462
- /**
463
- * Id of the reference
464
- */
465
- referenceId?: string;
466
- /**
467
- * Path to a property. Used if only part of the value is needed
468
- */
469
- path?: string;
470
- /**
471
- * If path is a reference, indicates the intention of it
472
- */
473
- meaning?: string;
474
- };
475
- value?: string | number | boolean | {
476
- [key: string]: any;
477
- } | any[];
478
- args?: {
479
- [key: string]: any;
480
- };
481
- }[][];
482
- /**
483
- * Logic specific settings. Will vary by type of logic
484
- */
485
- settings?: {
486
- [key: string]: any;
487
- };
488
- };
489
- };
490
- contextSchema?: {
491
- /**
492
- * Unique identifier for the context schema item
493
- */
494
- id?: string; // uuid
495
- /**
496
- * Type of the parameter. It could be either an entity slug, or a text
497
- */
498
- type: string;
499
- /**
500
- * Expected key to be received in the context
501
- */
502
- paramKey: string;
503
- /**
504
- * Indicates if a value is expected to be provided
505
- */
506
- isRequired?: boolean;
507
- /**
508
- * If type is not text, we can instruct the journey to fetch the entity id we receive as value
509
- */
510
- shouldLoadEntity?: boolean;
511
- }[];
512
- /**
513
- * Journey Template
514
- * example:
515
- * Sales template (Premium)
516
- */
517
- journey_type?: string;
518
- settings?: {
519
- embedOptions?: {
520
- mode?: "full-screen" | "inline";
521
- lang?: "de" | "en" | "fr";
522
- width?: string;
523
- topBar?: boolean;
524
- scrollToTop?: boolean;
525
- button?: {
526
- text?: string | null;
527
- align?: "left" | "center" | "right";
528
- };
529
- };
530
- safeModeAutomation?: boolean;
531
- /**
532
- * 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.
533
- */
534
- canary?: boolean;
535
- designId: string;
536
- templateId?: string;
537
- entityId?: string | null;
538
- mappingsAutomationId?: string;
539
- targetedCustomer?: string;
540
- description?: string | null;
541
- organizationSettings?: {
542
- [name: string]: boolean;
543
- } | null;
544
- publicToken?: string | null;
545
- runtimeEntities?: ("ORDER" | "OPPORTUNITY")[];
546
- filePurposes?: string[];
547
- entityTags?: string[];
548
- /**
549
- * @deprecated Use addressSuggestionsFileId instead
550
- */
551
- addressSuggestionsFileUrl?: string | null;
552
- addressSuggestionsFileId?: string | null;
553
- /**
554
- * Country code for address format (e.g. DE, AT, CH, LU)
555
- */
556
- addressSuggestionsCountryCode?: string | null;
557
- /**
558
- * Whether address auto-complete is enabled
559
- */
560
- addressSuggestionsEnableAutoComplete?: boolean;
561
- /**
562
- * Sources for address auto-complete (e.g. deutschePostService, customAddressesFile)
563
- */
564
- addressSuggestionsSource?: string[];
565
- /**
566
- * Whether free text input is allowed when auto-complete is on
567
- */
568
- addressSuggestionsEnableFreeText?: boolean;
569
- /**
570
- * This property is deprecated and will be removed in a future version
571
- */
572
- useNewDesign?: boolean;
573
- /**
574
- * If true, some journey input labels are in Austrian format
575
- */
576
- useAustrianLabels?: boolean;
577
- /**
578
- * If true, the journey shows an icon to toggle dark mode
579
- */
580
- enableDarkMode?: boolean;
581
- accessMode?: "PUBLIC" | "PRIVATE";
582
- isPublished?: boolean;
583
- status?: string;
584
- isActive?: boolean;
585
- savingProgress?: {
586
- savingMode?: "auto" | "local" | "remote" | "none";
587
- supportedVersion?: number;
588
- };
589
- /**
590
- * If false, third-party cookies are disabled to comply with GDPR regulations without asking for consent.
591
- */
592
- thirdPartyCookies?: boolean;
593
- };
594
- validationRules?: /**
595
- * References to validation rules organized by blocks and fields.
596
- * Maps block IDs to either rule IDs (for block-level rules) or rule references (for field-level rules).
597
- *
598
- * example:
599
- * {
600
- * "block1": "rule123",
601
- * "block2": {
602
- * "field1": "rule456",
603
- * "field2": "rule789"
604
- * }
605
- * }
606
- */
607
- ValidationRuleRef;
608
- createdBy?: string;
609
- updatedBy?: string | null;
610
- /**
611
- * If passed with value of null, the API won't modify the lastModifiedAt field on updating the journey
612
- */
613
- __lastModifiedAt?: string | null;
614
- }
615
- export interface JourneyCreationRequestV2 {
616
- journeyId?: string;
617
- brandId?: string;
618
- name: string;
619
- steps: {
620
- showStepName?: boolean | null;
621
- title?: string | null;
622
- subTitle?: string | null;
623
- showStepSubtitle?: boolean | null;
624
- showStepper?: boolean | null;
625
- showStepperLabels?: boolean | null;
626
- hideNextButton?: boolean | null;
627
- name: string;
628
- stepId?: string;
629
- schema: any;
630
- uischema: any;
631
- maxWidth?: "small" | "medium" | "large" | "extra large";
632
- }[];
633
- design?: {
634
- logoUrl?: string | null;
635
- theme?: {
636
- [name: string]: any;
637
- };
638
- designTokens?: {
639
- [key: string]: any;
640
- };
641
- };
642
- rules?: {
643
- type: "inject" | "injectWithKey";
644
- sourceType: "journey" | "step" | "block";
645
- source: string;
646
- target: string;
647
- }[];
648
- logics?: {
649
- autoGeneratedId?: string;
650
- conditions: string[];
651
- actions: string[];
652
- }[];
653
- logicsV4?: {
654
- [name: string]: {
655
- /**
656
- * Unique identifier for logic. Use uuidv7
657
- */
658
- id?: string; // uuid
659
- /**
660
- * If true, logic can't be manipulated by the configuring user
661
- */
662
- protected?: boolean;
663
- /**
664
- * Indicates which action to take in case logic evaluates to true
665
- */
666
- action?: string;
667
- /**
668
- * Indicates when the logic should be evaluated
669
- */
670
- triggeredOn?: string;
671
- conditions?: {
672
- /**
673
- * Operator to be applied between the fact value and the value
674
- */
675
- operator?: string;
676
- /**
677
- * If operator is a custom function, this needs to be provided
678
- */
679
- functionName?: string;
680
- fact?: {
681
- /**
682
- * Unique identifier for a fact
683
- */
684
- id?: string; // uuid
685
- /**
686
- * Indicates reference type (block or context parameter)
687
- */
688
- referenceType?: string;
689
- /**
690
- * Id of the reference
691
- */
692
- referenceId?: string;
693
- /**
694
- * Path to a property. Used if only part of the value is needed
695
- */
696
- path?: string;
697
- /**
698
- * If path is a reference, indicates the intention of it
699
- */
700
- meaning?: string;
701
- };
702
- value?: string | number | boolean | {
703
- [key: string]: any;
704
- } | any[];
705
- args?: {
706
- [key: string]: any;
707
- };
708
- }[][];
709
- /**
710
- * Logic specific settings. Will vary by type of logic
711
- */
712
- settings?: {
713
- [key: string]: any;
714
- };
715
- };
716
- };
717
- contextSchema?: {
718
- /**
719
- * Unique identifier for the context schema item
720
- */
721
- id?: string; // uuid
722
- /**
723
- * Type of the parameter. It could be either an entity slug, or a text
724
- */
725
- type: string;
726
- /**
727
- * Expected key to be received in the context
728
- */
729
- paramKey: string;
730
- /**
731
- * Indicates if a value is expected to be provided
732
- */
733
- isRequired?: boolean;
734
- /**
735
- * If type is not text, we can instruct the journey to fetch the entity id we receive as value
736
- */
737
- shouldLoadEntity?: boolean;
738
- }[];
739
- /**
740
- * Journey Template
741
- * example:
742
- * Sales template (Premium)
743
- */
744
- journey_type?: string;
745
- settings?: {
746
- embedOptions?: {
747
- mode?: "full-screen" | "inline";
748
- lang?: "de" | "en" | "fr";
749
- width?: string;
750
- topBar?: boolean;
751
- scrollToTop?: boolean;
752
- button?: {
753
- text?: string | null;
754
- align?: "left" | "center" | "right";
755
- };
756
- };
757
- safeModeAutomation?: boolean;
758
- designId?: string;
759
- entityId?: string | null;
760
- mappingsAutomationId?: string;
761
- templateId?: string;
762
- targetedCustomer?: string;
763
- description?: string | null;
764
- publicToken?: string | null;
765
- runtimeEntities?: ("ORDER" | "OPPORTUNITY")[];
766
- filePurposes?: string[];
767
- entityTags?: string[];
768
- /**
769
- * @deprecated Use addressSuggestionsFileId instead
770
- */
771
- addressSuggestionsFileUrl?: string | null;
772
- addressSuggestionsFileId?: string | null;
773
- /**
774
- * Country code for address format (e.g. DE, AT, CH, LU)
775
- */
776
- addressSuggestionsCountryCode?: string | null;
777
- /**
778
- * Whether address auto-complete is enabled
779
- */
780
- addressSuggestionsEnableAutoComplete?: boolean;
781
- /**
782
- * Sources for address auto-complete (e.g. deutschePostService, customAddressesFile)
783
- */
784
- addressSuggestionsSource?: string[];
785
- /**
786
- * Whether free text input is allowed when auto-complete is on
787
- */
788
- addressSuggestionsEnableFreeText?: boolean;
789
- /**
790
- * This property is deprecated and will be removed in a future version
791
- */
792
- useNewDesign?: boolean;
793
- /**
794
- * If false, third-party cookies are disabled to comply with GDPR regulations without asking for consent.
795
- */
796
- thirdPartyCookies?: boolean;
797
- accessMode?: "PUBLIC" | "PRIVATE";
798
- /**
799
- * If true, the journey shows an icon to toggle dark mode
800
- */
801
- enableDarkMode?: boolean;
802
- };
803
- validationRules?: /**
804
- * References to validation rules organized by blocks and fields.
805
- * Maps block IDs to either rule IDs (for block-level rules) or rule references (for field-level rules).
806
- *
807
- * example:
808
- * {
809
- * "block1": "rule123",
810
- * "block2": {
811
- * "field1": "rule456",
812
- * "field2": "rule789"
813
- * }
814
- * }
815
- */
816
- ValidationRuleRef;
817
- /**
818
- * Manifest/Blueprint ID used to create/update the entity
819
- */
820
- _manifest?: string /* uuid */[];
821
- }
822
- export interface JourneyFeatureFlags {
823
- featureFlags?: {
824
- [name: string]: any;
825
- };
826
- }
827
- export type JourneyProductsResponse = {
828
- type?: string;
829
- _schema?: string;
830
- _title?: string;
831
- name?: string;
832
- _id?: string;
833
- _org?: string;
834
- code?: string;
835
- description?: string;
836
- feature?: any[];
837
- product_images?: any[];
838
- legal_footnote?: string;
839
- product_downloads?: any[];
840
- price?: {
841
- [key: string]: any;
842
- };
843
- }[];
844
- export interface JourneyResponse {
845
- createdJourney?: Journey;
846
- }
847
- export interface JourneyValidationError {
848
- /**
849
- * Error type identifier
850
- * example:
851
- * ValidationError
852
- */
853
- error: string;
854
- /**
855
- * High-level error message
856
- * example:
857
- * Journey configuration validation failed
858
- */
859
- message: string;
860
- /**
861
- * Detailed validation errors for each pattern that failed
862
- */
863
- details: {
864
- /**
865
- * Validation pattern that failed
866
- */
867
- pattern?: string;
868
- severity?: "critical" | "high" | "medium" | "low";
869
- /**
870
- * Detailed error message
871
- */
872
- message?: string;
873
- /**
874
- * Number of issues found
875
- */
876
- count?: number;
877
- }[];
878
- }
879
- export interface JourneyValidationResponse {
880
- /**
881
- * Whether the journey configuration is valid
882
- */
883
- valid: boolean;
884
- /**
885
- * List of detected validation errors
886
- */
887
- errors: {
888
- /**
889
- * Pattern type (e.g. PatternA_DotsInStepId)
890
- */
891
- type?: string;
892
- severity?: "critical" | "high" | "medium" | "low";
893
- message?: string;
894
- affectedStepIds?: string[];
895
- count?: number;
896
- autoFix?: {
897
- feasible?: boolean;
898
- confidence?: "high" | "medium" | "low";
899
- reason?: string;
900
- details?: string;
901
- };
902
- }[];
903
- /**
904
- * List of warnings (non-critical issues)
905
- */
906
- warnings?: {
907
- type?: string;
908
- message?: string;
909
- }[];
910
- }
911
- /**
912
- * Patch request to update a journey (journey id is required) Support for nested properties (e.g. steps[0].uischema.elements[0].products) is supported.
913
- *
914
- */
915
- export interface PatchUpdateJourneyRequest {
916
- [name: string]: any;
917
- /**
918
- * example:
919
- * 509cdffe-424f-457a-95c2-9708c304ce77
920
- */
921
- journeyId: string; // uuid
922
- /**
923
- * If passed with value of null, the API won't modify the lastModifiedAt field on updating the journey
924
- */
925
- __lastModifiedAt?: string | null;
926
- }
927
- /**
928
- * Field-level rule references within a block.
929
- * Maps field names to rule IDs.
930
- *
931
- * example:
932
- * {
933
- * "firstName": "rule123",
934
- * "lastName": "rule456",
935
- * "email": "rule789"
936
- * }
937
- */
938
- export interface RuleRef {
939
- [name: string]: string;
940
- }
941
- export interface S3Reference {
942
- /**
943
- * example:
944
- * document-api-prod
945
- */
946
- bucket: string;
947
- /**
948
- * example:
949
- * uploads/my-template.pdf
950
- */
951
- key: string;
952
- }
953
- export interface SearchJourneysQueryRequest {
954
- /**
955
- * Lucene query syntax
956
- * See https://lucene.apache.org/core/2_9_4/queryparsersyntax.html ; https://www.elastic.co/guide/en/kibana/current/lucene-query.html
957
- *
958
- * example:
959
- * _tags:*Flex*
960
- */
961
- q?: string;
962
- /**
963
- * The offset of the first result to return.
964
- * See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html
965
- *
966
- * example:
967
- * 0
968
- */
969
- from?: number;
970
- /**
971
- * The maximum number of results to return.
972
- * See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html
973
- *
974
- * example:
975
- * 25
976
- */
977
- size?: number;
978
- /**
979
- * The sort order. Follows Lucene syntax.
980
- *
981
- * example:
982
- * _created_at:desc
983
- */
984
- sort?: string;
985
- }
986
- export interface SearchJourneysResponse {
987
- /**
988
- * The total number of hits.
989
- *
990
- * example:
991
- * 1
992
- */
993
- hits?: number;
994
- /**
995
- * The results.
996
- *
997
- */
998
- results?: {
999
- /**
1000
- * Journey Entity ID
1001
- * example:
1002
- * e0f8f8f8-f8f8-f8f8-f8f8-f8f8f8f8f8f8
1003
- */
1004
- _id?: string; // uuid
1005
- /**
1006
- * Entity Schema (journey always in this case)
1007
- * example:
1008
- * journey
1009
- */
1010
- _schema?: string;
1011
- /**
1012
- * Journey Entity Title
1013
- * example:
1014
- * Journey Entity Title
1015
- */
1016
- _title?: string;
1017
- /**
1018
- * Organization ID
1019
- * example:
1020
- * 739224
1021
- */
1022
- _org?: string;
1023
- /**
1024
- * example:
1025
- * 2020-01-01T00:00:00.000Z
1026
- */
1027
- _created_at?: string; // date-time
1028
- /**
1029
- * example:
1030
- * 2020-01-01T00:00:00.000Z
1031
- */
1032
- _updated_at?: string; // date-time
1033
- _tags?: string[];
1034
- /**
1035
- * Manifest ID used to create/update the entity
1036
- */
1037
- _manifest?: string /* uuid */[];
1038
- /**
1039
- * Journey Name
1040
- * example:
1041
- * Journey Name
1042
- */
1043
- journey_name?: string;
1044
- /**
1045
- * Journey config ID
1046
- * example:
1047
- * de7df470-253e-11ed-9174-116b8a718c0a
1048
- */
1049
- journey_id?: string; // uuid
1050
- /**
1051
- * Journey Template
1052
- * example:
1053
- * Sales template
1054
- */
1055
- journey_type?: string;
1056
- /**
1057
- * Journey Design Name
1058
- * example:
1059
- * Design EPILOT
1060
- */
1061
- design?: string;
1062
- created_by?: {
1063
- /**
1064
- * User ID
1065
- * example:
1066
- * 12345
1067
- */
1068
- id?: string;
1069
- }[];
1070
- /**
1071
- * Journey Version
1072
- */
1073
- journey_version?: "Flex";
1074
- }[];
1075
- }
1076
- /**
1077
- * Template Settings for document generation
1078
- */
1079
- export interface TemplateSettings {
1080
- /**
1081
- * Custom margins for the document
1082
- */
1083
- custom_margins?: {
1084
- /**
1085
- * Top margin in cm
1086
- * example:
1087
- * 2.54
1088
- */
1089
- top?: number;
1090
- /**
1091
- * Bottom margin in cm
1092
- * example:
1093
- * 2.54
1094
- */
1095
- bottom?: number;
1096
- };
1097
- /**
1098
- * Suggested margins for the document
1099
- */
1100
- suggested_margins?: {
1101
- /**
1102
- * Top margin in cm
1103
- * example:
1104
- * 2.54
1105
- */
1106
- top?: number;
1107
- /**
1108
- * Bottom margin in cm
1109
- * example:
1110
- * 2.54
1111
- */
1112
- bottom?: number;
1113
- };
1114
- /**
1115
- * Display margin guidelines (applicable to partial generation only)
1116
- * example:
1117
- * true
1118
- */
1119
- display_margin_guidelines?: boolean;
1120
- /**
1121
- * Enable data table margin autofix
1122
- * example:
1123
- * false
1124
- */
1125
- enable_data_table_margin_autofix?: boolean;
1126
- /**
1127
- * A flag that indicates whether the template has 1 or more data tables in it
1128
- * example:
1129
- * false
1130
- */
1131
- template_with_datatable?: boolean;
1132
- /**
1133
- * Enables the persistance of template settings
1134
- * example:
1135
- * false
1136
- */
1137
- enabled_template_settings_persistence?: boolean;
1138
- /**
1139
- * An indication that the page margins are misconfigured
1140
- * example:
1141
- * false
1142
- */
1143
- misconfigured_margins?: boolean;
1144
- /**
1145
- * The file entity id, used when persisting a new template version with updated settings
1146
- * example:
1147
- * 1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d
1148
- */
1149
- file_entity_id?: string; // uuid
1150
- }
1151
- /**
1152
- * References to validation rules organized by blocks and fields.
1153
- * Maps block IDs to either rule IDs (for block-level rules) or rule references (for field-level rules).
1154
- *
1155
- * example:
1156
- * {
1157
- * "block1": "rule123",
1158
- * "block2": {
1159
- * "field1": "rule456",
1160
- * "field2": "rule789"
1161
- * }
1162
- * }
1163
- */
1164
- export interface ValidationRuleRef {
1165
- [name: string]: string | /**
1166
- * Field-level rule references within a block.
1167
- * Maps field names to rule IDs.
1168
- *
1169
- * example:
1170
- * {
1171
- * "firstName": "rule123",
1172
- * "lastName": "rule456",
1173
- * "email": "rule789"
1174
- * }
1175
- */
1176
- RuleRef;
1177
- }
1178
- }
1179
- }
1180
- declare namespace Paths {
1181
- namespace CreateJourney {
1182
- namespace Parameters {
1183
- /**
1184
- * example:
1185
- * true
1186
- */
1187
- export type SkipAutomation = string; // Yn
1188
- }
1189
- export interface QueryParameters {
1190
- skipAutomation?: /**
1191
- * example:
1192
- * true
1193
- */
1194
- Parameters.SkipAutomation /* Yn */;
1195
- }
1196
- export type RequestBody = Components.Schemas.JourneyCreationRequest;
1197
- namespace Responses {
1198
- export type $201 = Components.Schemas.Journey;
1199
- export type $400 = Components.Schemas.JourneyValidationError;
1200
- }
1201
- }
1202
- namespace CreateJourneyV2 {
1203
- namespace Parameters {
1204
- /**
1205
- * example:
1206
- * true
1207
- */
1208
- export type SkipAutomation = string; // Yn
1209
- }
1210
- export interface QueryParameters {
1211
- skipAutomation?: /**
1212
- * example:
1213
- * true
1214
- */
1215
- Parameters.SkipAutomation /* Yn */;
1216
- }
1217
- export type RequestBody = Components.Schemas.JourneyCreationRequestV2;
1218
- namespace Responses {
1219
- export type $201 = Components.Schemas.JourneyCreationRequestV2;
1220
- export type $400 = Components.Schemas.JourneyValidationError;
1221
- }
1222
- }
1223
- namespace GenerateDocument {
1224
- export type RequestBody = Components.Schemas.GenerateDocumentRequest;
1225
- namespace Responses {
1226
- export type $200 = Components.Schemas.GenerateDocumentResponse;
1227
- }
1228
- }
1229
- namespace GetButtonOptions {
1230
- namespace Parameters {
1231
- /**
1232
- * example:
1233
- * 535ef74a-dd66-4d01-94a9-725016e70d1c
1234
- */
1235
- export type FileId = string;
1236
- }
1237
- export interface QueryParameters {
1238
- fileId: /**
1239
- * example:
1240
- * 535ef74a-dd66-4d01-94a9-725016e70d1c
1241
- */
1242
- Parameters.FileId;
1243
- }
1244
- namespace Responses {
1245
- export type $200 = /* A single button option data */ Components.Schemas.ButtonOption[];
1246
- export interface $400 {
1247
- /**
1248
- * example:
1249
- * UTF-8 encoding error while processing CSV content
1250
- */
1251
- message?: string;
1252
- /**
1253
- * example:
1254
- * Please ensure your CSV file is properly encoded in UTF-8 format
1255
- */
1256
- details?: string;
1257
- }
1258
- export interface $404 {
1259
- /**
1260
- * example:
1261
- * File with ID 535ef74a-dd66-4d01-94a9-725016e70d1c not found.
1262
- */
1263
- message?: string;
1264
- }
1265
- export interface $500 {
1266
- /**
1267
- * example:
1268
- * Unknown API Error
1269
- */
1270
- message?: string;
1271
- }
1272
- }
1273
- }
1274
- namespace GetJourney {
1275
- namespace Parameters {
1276
- /**
1277
- * example:
1278
- * 509cdffe-424f-457a-95c2-9708c304ce77
1279
- */
1280
- export type Id = string; // uuid
1281
- export type OrgId = string;
1282
- export type Source = string;
1283
- }
1284
- export interface PathParameters {
1285
- id: /**
1286
- * example:
1287
- * 509cdffe-424f-457a-95c2-9708c304ce77
1288
- */
1289
- Parameters.Id /* uuid */;
1290
- }
1291
- export interface QueryParameters {
1292
- source?: Parameters.Source;
1293
- orgId?: Parameters.OrgId;
1294
- }
1295
- namespace Responses {
1296
- export type $200 = Components.Schemas.Journey;
1297
- }
1298
- }
1299
- namespace GetJourneyProducts {
1300
- namespace Parameters {
1301
- export type City = string;
1302
- /**
1303
- * example:
1304
- * 509cdffe-424f-457a-95c2-9708c304ce77
1305
- */
1306
- export type Id = string; // uuid
1307
- export type PostalCode = string;
1308
- export type Source = string;
1309
- export type Street = string;
1310
- export type StreetNumber = string;
1311
- }
1312
- export interface PathParameters {
1313
- id: /**
1314
- * example:
1315
- * 509cdffe-424f-457a-95c2-9708c304ce77
1316
- */
1317
- Parameters.Id /* uuid */;
1318
- }
1319
- export interface QueryParameters {
1320
- source?: Parameters.Source;
1321
- postal_code?: Parameters.PostalCode;
1322
- city?: Parameters.City;
1323
- street?: Parameters.Street;
1324
- street_number?: Parameters.StreetNumber;
1325
- }
1326
- namespace Responses {
1327
- export type $200 = Components.Schemas.JourneyProductsResponse;
1328
- }
1329
- }
1330
- namespace GetJourneyV2 {
1331
- namespace Parameters {
1332
- /**
1333
- * example:
1334
- * 509cdffe-424f-457a-95c2-9708c304ce77
1335
- */
1336
- export type Id = string; // uuid
1337
- }
1338
- export interface PathParameters {
1339
- id: /**
1340
- * example:
1341
- * 509cdffe-424f-457a-95c2-9708c304ce77
1342
- */
1343
- Parameters.Id /* uuid */;
1344
- }
1345
- namespace Responses {
1346
- export type $200 = Components.Schemas.JourneyCreationRequestV2;
1347
- }
1348
- }
1349
- namespace GetJourneysByOrgId {
1350
- namespace Parameters {
1351
- /**
1352
- * example:
1353
- * true
1354
- */
1355
- export type Hydrate = string;
1356
- /**
1357
- * example:
1358
- * 123
1359
- */
1360
- export type Id = string;
1361
- }
1362
- export interface PathParameters {
1363
- id: /**
1364
- * example:
1365
- * 123
1366
- */
1367
- Parameters.Id;
1368
- }
1369
- export interface QueryParameters {
1370
- hydrate?: /**
1371
- * example:
1372
- * true
1373
- */
1374
- Parameters.Hydrate;
1375
- }
1376
- namespace Responses {
1377
- export type $200 = Components.Schemas.GetJourneysResponse;
1378
- }
1379
- }
1380
- namespace GetSettingsForJourney {
1381
- namespace Parameters {
1382
- /**
1383
- * example:
1384
- * 509cdffe-424f-457a-95c2-9708c304ce77
1385
- */
1386
- export type Id = string; // uuid
1387
- }
1388
- export interface PathParameters {
1389
- id: /**
1390
- * example:
1391
- * 509cdffe-424f-457a-95c2-9708c304ce77
1392
- */
1393
- Parameters.Id /* uuid */;
1394
- }
1395
- namespace Responses {
1396
- export type $200 = Components.Schemas.GetSettingsForJourney;
1397
- export interface $404 {
1398
- /**
1399
- * example:
1400
- * journey not found
1401
- */
1402
- message?: string;
1403
- }
1404
- export interface $500 {
1405
- /**
1406
- * example:
1407
- * Unknown API Error
1408
- */
1409
- message?: string;
1410
- }
1411
- }
1412
- }
1413
- namespace PatchUpdateJourney {
1414
- export type RequestBody = /**
1415
- * Patch request to update a journey (journey id is required) Support for nested properties (e.g. steps[0].uischema.elements[0].products) is supported.
1416
- *
1417
- */
1418
- Components.Schemas.PatchUpdateJourneyRequest;
1419
- namespace Responses {
1420
- export type $200 = Components.Schemas.JourneyResponse;
1421
- export type $400 = Components.Schemas.JourneyValidationError;
1422
- export interface $404 {
1423
- /**
1424
- * example:
1425
- * journey not found
1426
- */
1427
- message?: string;
1428
- }
1429
- }
1430
- }
1431
- namespace PatchUpdateJourneyV2 {
1432
- export type RequestBody = /**
1433
- * Patch request to update a journey (journey id is required) Support for nested properties (e.g. steps[0].uischema.elements[0].products) is supported.
1434
- *
1435
- */
1436
- Components.Schemas.PatchUpdateJourneyRequest;
1437
- namespace Responses {
1438
- export type $200 = Components.Schemas.JourneyCreationRequestV2;
1439
- export type $400 = Components.Schemas.JourneyValidationError;
1440
- export interface $404 {
1441
- /**
1442
- * example:
1443
- * journey not found
1444
- */
1445
- message?: string;
1446
- }
1447
- }
1448
- }
1449
- namespace RemoveJourney {
1450
- namespace Parameters {
1451
- /**
1452
- * example:
1453
- * 509cdffe-424f-457a-95c2-9708c304ce77
1454
- */
1455
- export type Id = string; // uuid
1456
- }
1457
- export interface PathParameters {
1458
- id: /**
1459
- * example:
1460
- * 509cdffe-424f-457a-95c2-9708c304ce77
1461
- */
1462
- Parameters.Id /* uuid */;
1463
- }
1464
- namespace Responses {
1465
- export interface $404 {
1466
- /**
1467
- * example:
1468
- * journey not found
1469
- */
1470
- message?: string;
1471
- }
1472
- }
1473
- }
1474
- namespace RemoveJourneyV2 {
1475
- namespace Parameters {
1476
- /**
1477
- * example:
1478
- * 509cdffe-424f-457a-95c2-9708c304ce77
1479
- */
1480
- export type Id = string; // uuid
1481
- }
1482
- export interface PathParameters {
1483
- id: /**
1484
- * example:
1485
- * 509cdffe-424f-457a-95c2-9708c304ce77
1486
- */
1487
- Parameters.Id /* uuid */;
1488
- }
1489
- }
1490
- namespace SearchJourneys {
1491
- export type RequestBody = Components.Schemas.SearchJourneysQueryRequest;
1492
- namespace Responses {
1493
- export type $200 = Components.Schemas.SearchJourneysResponse;
1494
- }
1495
- }
1496
- namespace UpdateJourney {
1497
- export type RequestBody = Components.Schemas.JourneyCreationRequest;
1498
- namespace Responses {
1499
- export interface $204 {
1500
- }
1501
- export type $400 = Components.Schemas.JourneyValidationError;
1502
- export interface $409 {
1503
- }
1504
- }
1505
- }
1506
- namespace UpdateJourneyV2 {
1507
- export type RequestBody = Components.Schemas.JourneyCreationRequestV2;
1508
- namespace Responses {
1509
- export type $200 = Components.Schemas.JourneyCreationRequestV2;
1510
- export type $400 = Components.Schemas.JourneyValidationError;
1511
- export interface $404 {
1512
- /**
1513
- * example:
1514
- * journey not found
1515
- */
1516
- message?: string;
1517
- }
1518
- }
1519
- }
1520
- }
1521
-
1522
-
1523
- export interface OperationMethods {
1524
- /**
1525
- * getJourneysByOrgId - getJourneysByOrgId
1526
- *
1527
- * Get all journeys by organization id
1528
- */
1529
- 'getJourneysByOrgId'(
1530
- parameters?: Parameters<Paths.GetJourneysByOrgId.QueryParameters & Paths.GetJourneysByOrgId.PathParameters> | null,
1531
- data?: any,
1532
- config?: AxiosRequestConfig
1533
- ): OperationResponse<Paths.GetJourneysByOrgId.Responses.$200>
1534
- /**
1535
- * getJourney - getJourney
1536
- *
1537
- * Get journey by id. Private journeys requires valid private token to be passed
1538
- */
1539
- 'getJourney'(
1540
- parameters?: Parameters<Paths.GetJourney.QueryParameters & Paths.GetJourney.PathParameters> | null,
1541
- data?: any,
1542
- config?: AxiosRequestConfig
1543
- ): OperationResponse<Paths.GetJourney.Responses.$200>
1544
- /**
1545
- * removeJourney - removeJourney
1546
- *
1547
- * Remove journey by id
1548
- */
1549
- 'removeJourney'(
1550
- parameters?: Parameters<Paths.RemoveJourney.PathParameters> | null,
1551
- data?: any,
1552
- config?: AxiosRequestConfig
1553
- ): OperationResponse<any>
1554
- /**
1555
- * getJourneyProducts - getJourneyProducts
1556
- *
1557
- * Get products available in the journey by id. requires public journey token to be passed.
1558
- */
1559
- 'getJourneyProducts'(
1560
- parameters?: Parameters<Paths.GetJourneyProducts.QueryParameters & Paths.GetJourneyProducts.PathParameters> | null,
1561
- data?: any,
1562
- config?: AxiosRequestConfig
1563
- ): OperationResponse<Paths.GetJourneyProducts.Responses.$200>
1564
- /**
1565
- * updateJourney - updateJourney
1566
- *
1567
- * Update a Journey
1568
- */
1569
- 'updateJourney'(
1570
- parameters?: Parameters<UnknownParamsObject> | null,
1571
- data?: Paths.UpdateJourney.RequestBody,
1572
- config?: AxiosRequestConfig
1573
- ): OperationResponse<Paths.UpdateJourney.Responses.$204>
1574
- /**
1575
- * createJourney - createJourney
1576
- *
1577
- * Create a Journey
1578
- */
1579
- 'createJourney'(
1580
- parameters?: Parameters<Paths.CreateJourney.QueryParameters> | null,
1581
- data?: Paths.CreateJourney.RequestBody,
1582
- config?: AxiosRequestConfig
1583
- ): OperationResponse<Paths.CreateJourney.Responses.$201>
1584
- /**
1585
- * patchUpdateJourney - patchUpdateJourney
1586
- *
1587
- * Update a Journey (partially / patch). Support for nested properties updates (e.g. "property[0].name").
1588
- */
1589
- 'patchUpdateJourney'(
1590
- parameters?: Parameters<UnknownParamsObject> | null,
1591
- data?: Paths.PatchUpdateJourney.RequestBody,
1592
- config?: AxiosRequestConfig
1593
- ): OperationResponse<Paths.PatchUpdateJourney.Responses.$200>
1594
- /**
1595
- * searchJourneys - searchJourneys
1596
- *
1597
- * Search Journeys
1598
- */
1599
- 'searchJourneys'(
1600
- parameters?: Parameters<UnknownParamsObject> | null,
1601
- data?: Paths.SearchJourneys.RequestBody,
1602
- config?: AxiosRequestConfig
1603
- ): OperationResponse<Paths.SearchJourneys.Responses.$200>
1604
- /**
1605
- * generateDocument - generateDocument
1606
- *
1607
- * Builds document generated from a template with journey values."
1608
- *
1609
- * Supported input document types:
1610
- * - .docx
1611
- *
1612
- * Supported output document types:
1613
- * - .pdf
1614
- * - .docx but limited to only text based variables
1615
- *
1616
- * Uses [Document API](https://gitlab.com/e-pilot/product/file-management/document-api) to generate the document.
1617
- * Uses [Template Variables API](https://docs.epilot.io/api/template-variables) to replace variables in the document.
1618
- *
1619
- */
1620
- 'generateDocument'(
1621
- parameters?: Parameters<UnknownParamsObject> | null,
1622
- data?: Paths.GenerateDocument.RequestBody,
1623
- config?: AxiosRequestConfig
1624
- ): OperationResponse<Paths.GenerateDocument.Responses.$200>
1625
- /**
1626
- * updateJourneyV2 - updateJourneyV2
1627
- *
1628
- * Update a Journey
1629
- */
1630
- 'updateJourneyV2'(
1631
- parameters?: Parameters<UnknownParamsObject> | null,
1632
- data?: Paths.UpdateJourneyV2.RequestBody,
1633
- config?: AxiosRequestConfig
1634
- ): OperationResponse<Paths.UpdateJourneyV2.Responses.$200>
1635
- /**
1636
- * createJourneyV2 - createJourneyV2
1637
- *
1638
- * Create a Journey
1639
- */
1640
- 'createJourneyV2'(
1641
- parameters?: Parameters<Paths.CreateJourneyV2.QueryParameters> | null,
1642
- data?: Paths.CreateJourneyV2.RequestBody,
1643
- config?: AxiosRequestConfig
1644
- ): OperationResponse<Paths.CreateJourneyV2.Responses.$201>
1645
- /**
1646
- * patchUpdateJourneyV2 - patchUpdateJourneyV2
1647
- *
1648
- * Update a Journey (partially / patch). Support for nested properties updates (e.g. "property[0].name").
1649
- */
1650
- 'patchUpdateJourneyV2'(
1651
- parameters?: Parameters<UnknownParamsObject> | null,
1652
- data?: Paths.PatchUpdateJourneyV2.RequestBody,
1653
- config?: AxiosRequestConfig
1654
- ): OperationResponse<Paths.PatchUpdateJourneyV2.Responses.$200>
1655
- /**
1656
- * getJourneyV2 - getJourneyV2
1657
- *
1658
- * Get journey by id
1659
- */
1660
- 'getJourneyV2'(
1661
- parameters?: Parameters<Paths.GetJourneyV2.PathParameters> | null,
1662
- data?: any,
1663
- config?: AxiosRequestConfig
1664
- ): OperationResponse<Paths.GetJourneyV2.Responses.$200>
1665
- /**
1666
- * removeJourneyV2 - removeJourneyV2
1667
- *
1668
- * Remove journey by id
1669
- */
1670
- 'removeJourneyV2'(
1671
- parameters?: Parameters<Paths.RemoveJourneyV2.PathParameters> | null,
1672
- data?: any,
1673
- config?: AxiosRequestConfig
1674
- ): OperationResponse<any>
1675
- /**
1676
- * getSettingsForJourney - getSettingsForJourney
1677
- *
1678
- * Get settings related to the journey using journey ID.
1679
- */
1680
- 'getSettingsForJourney'(
1681
- parameters?: Parameters<Paths.GetSettingsForJourney.PathParameters> | null,
1682
- data?: any,
1683
- config?: AxiosRequestConfig
1684
- ): OperationResponse<Paths.GetSettingsForJourney.Responses.$200>
1685
- /**
1686
- * getButtonOptions - getButtonOptions
1687
- *
1688
- * Get button options from a csv file.
1689
- */
1690
- 'getButtonOptions'(
1691
- parameters?: Parameters<Paths.GetButtonOptions.QueryParameters> | null,
1692
- data?: any,
1693
- config?: AxiosRequestConfig
1694
- ): OperationResponse<Paths.GetButtonOptions.Responses.$200>
1695
- }
1696
-
1697
- export interface PathsDictionary {
1698
- ['/v1/journey/organization/{id}']: {
1699
- /**
1700
- * getJourneysByOrgId - getJourneysByOrgId
1701
- *
1702
- * Get all journeys by organization id
1703
- */
1704
- 'get'(
1705
- parameters?: Parameters<Paths.GetJourneysByOrgId.QueryParameters & Paths.GetJourneysByOrgId.PathParameters> | null,
1706
- data?: any,
1707
- config?: AxiosRequestConfig
1708
- ): OperationResponse<Paths.GetJourneysByOrgId.Responses.$200>
1709
- }
1710
- ['/v1/journey/configuration/{id}']: {
1711
- /**
1712
- * getJourney - getJourney
1713
- *
1714
- * Get journey by id. Private journeys requires valid private token to be passed
1715
- */
1716
- 'get'(
1717
- parameters?: Parameters<Paths.GetJourney.QueryParameters & Paths.GetJourney.PathParameters> | null,
1718
- data?: any,
1719
- config?: AxiosRequestConfig
1720
- ): OperationResponse<Paths.GetJourney.Responses.$200>
1721
- /**
1722
- * removeJourney - removeJourney
1723
- *
1724
- * Remove journey by id
1725
- */
1726
- 'delete'(
1727
- parameters?: Parameters<Paths.RemoveJourney.PathParameters> | null,
1728
- data?: any,
1729
- config?: AxiosRequestConfig
1730
- ): OperationResponse<any>
1731
- }
1732
- ['/v1/journey/products/{id}']: {
1733
- /**
1734
- * getJourneyProducts - getJourneyProducts
1735
- *
1736
- * Get products available in the journey by id. requires public journey token to be passed.
1737
- */
1738
- 'get'(
1739
- parameters?: Parameters<Paths.GetJourneyProducts.QueryParameters & Paths.GetJourneyProducts.PathParameters> | null,
1740
- data?: any,
1741
- config?: AxiosRequestConfig
1742
- ): OperationResponse<Paths.GetJourneyProducts.Responses.$200>
1743
- }
1744
- ['/v1/journey/configuration']: {
1745
- /**
1746
- * createJourney - createJourney
1747
- *
1748
- * Create a Journey
1749
- */
1750
- 'post'(
1751
- parameters?: Parameters<Paths.CreateJourney.QueryParameters> | null,
1752
- data?: Paths.CreateJourney.RequestBody,
1753
- config?: AxiosRequestConfig
1754
- ): OperationResponse<Paths.CreateJourney.Responses.$201>
1755
- /**
1756
- * updateJourney - updateJourney
1757
- *
1758
- * Update a Journey
1759
- */
1760
- 'put'(
1761
- parameters?: Parameters<UnknownParamsObject> | null,
1762
- data?: Paths.UpdateJourney.RequestBody,
1763
- config?: AxiosRequestConfig
1764
- ): OperationResponse<Paths.UpdateJourney.Responses.$204>
1765
- /**
1766
- * patchUpdateJourney - patchUpdateJourney
1767
- *
1768
- * Update a Journey (partially / patch). Support for nested properties updates (e.g. "property[0].name").
1769
- */
1770
- 'patch'(
1771
- parameters?: Parameters<UnknownParamsObject> | null,
1772
- data?: Paths.PatchUpdateJourney.RequestBody,
1773
- config?: AxiosRequestConfig
1774
- ): OperationResponse<Paths.PatchUpdateJourney.Responses.$200>
1775
- }
1776
- ['/v1/journey/configuration/search']: {
1777
- /**
1778
- * searchJourneys - searchJourneys
1779
- *
1780
- * Search Journeys
1781
- */
1782
- 'post'(
1783
- parameters?: Parameters<UnknownParamsObject> | null,
1784
- data?: Paths.SearchJourneys.RequestBody,
1785
- config?: AxiosRequestConfig
1786
- ): OperationResponse<Paths.SearchJourneys.Responses.$200>
1787
- }
1788
- ['/v1/journey/document:generate']: {
1789
- /**
1790
- * generateDocument - generateDocument
1791
- *
1792
- * Builds document generated from a template with journey values."
1793
- *
1794
- * Supported input document types:
1795
- * - .docx
1796
- *
1797
- * Supported output document types:
1798
- * - .pdf
1799
- * - .docx but limited to only text based variables
1800
- *
1801
- * Uses [Document API](https://gitlab.com/e-pilot/product/file-management/document-api) to generate the document.
1802
- * Uses [Template Variables API](https://docs.epilot.io/api/template-variables) to replace variables in the document.
1803
- *
1804
- */
1805
- 'post'(
1806
- parameters?: Parameters<UnknownParamsObject> | null,
1807
- data?: Paths.GenerateDocument.RequestBody,
1808
- config?: AxiosRequestConfig
1809
- ): OperationResponse<Paths.GenerateDocument.Responses.$200>
1810
- }
1811
- ['/v2/journey/configuration']: {
1812
- /**
1813
- * createJourneyV2 - createJourneyV2
1814
- *
1815
- * Create a Journey
1816
- */
1817
- 'post'(
1818
- parameters?: Parameters<Paths.CreateJourneyV2.QueryParameters> | null,
1819
- data?: Paths.CreateJourneyV2.RequestBody,
1820
- config?: AxiosRequestConfig
1821
- ): OperationResponse<Paths.CreateJourneyV2.Responses.$201>
1822
- /**
1823
- * updateJourneyV2 - updateJourneyV2
1824
- *
1825
- * Update a Journey
1826
- */
1827
- 'put'(
1828
- parameters?: Parameters<UnknownParamsObject> | null,
1829
- data?: Paths.UpdateJourneyV2.RequestBody,
1830
- config?: AxiosRequestConfig
1831
- ): OperationResponse<Paths.UpdateJourneyV2.Responses.$200>
1832
- /**
1833
- * patchUpdateJourneyV2 - patchUpdateJourneyV2
1834
- *
1835
- * Update a Journey (partially / patch). Support for nested properties updates (e.g. "property[0].name").
1836
- */
1837
- 'patch'(
1838
- parameters?: Parameters<UnknownParamsObject> | null,
1839
- data?: Paths.PatchUpdateJourneyV2.RequestBody,
1840
- config?: AxiosRequestConfig
1841
- ): OperationResponse<Paths.PatchUpdateJourneyV2.Responses.$200>
1842
- }
1843
- ['/v2/journey/configuration/{id}']: {
1844
- /**
1845
- * getJourneyV2 - getJourneyV2
1846
- *
1847
- * Get journey by id
1848
- */
1849
- 'get'(
1850
- parameters?: Parameters<Paths.GetJourneyV2.PathParameters> | null,
1851
- data?: any,
1852
- config?: AxiosRequestConfig
1853
- ): OperationResponse<Paths.GetJourneyV2.Responses.$200>
1854
- /**
1855
- * removeJourneyV2 - removeJourneyV2
1856
- *
1857
- * Remove journey by id
1858
- */
1859
- 'delete'(
1860
- parameters?: Parameters<Paths.RemoveJourneyV2.PathParameters> | null,
1861
- data?: any,
1862
- config?: AxiosRequestConfig
1863
- ): OperationResponse<any>
1864
- }
1865
- ['/v1/journey/{id}/settings']: {
1866
- /**
1867
- * getSettingsForJourney - getSettingsForJourney
1868
- *
1869
- * Get settings related to the journey using journey ID.
1870
- */
1871
- 'get'(
1872
- parameters?: Parameters<Paths.GetSettingsForJourney.PathParameters> | null,
1873
- data?: any,
1874
- config?: AxiosRequestConfig
1875
- ): OperationResponse<Paths.GetSettingsForJourney.Responses.$200>
1876
- }
1877
- ['/v1/journey/button-options']: {
1878
- /**
1879
- * getButtonOptions - getButtonOptions
1880
- *
1881
- * Get button options from a csv file.
1882
- */
1883
- 'get'(
1884
- parameters?: Parameters<Paths.GetButtonOptions.QueryParameters> | null,
1885
- data?: any,
1886
- config?: AxiosRequestConfig
1887
- ): OperationResponse<Paths.GetButtonOptions.Responses.$200>
1888
- }
1889
- }
1890
-
1891
- export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
1892
-
1893
-
1894
- export type ButtonOption = Components.Schemas.ButtonOption;
1895
- export type GenerateDocumentRequest = Components.Schemas.GenerateDocumentRequest;
1896
- export type GenerateDocumentResponse = Components.Schemas.GenerateDocumentResponse;
1897
- export type GetJourneysResponse = Components.Schemas.GetJourneysResponse;
1898
- export type GetSettingsForJourney = Components.Schemas.GetSettingsForJourney;
1899
- export type Journey = Components.Schemas.Journey;
1900
- export type JourneyAuditInfo = Components.Schemas.JourneyAuditInfo;
1901
- export type JourneyCreationRequest = Components.Schemas.JourneyCreationRequest;
1902
- export type JourneyCreationRequestV2 = Components.Schemas.JourneyCreationRequestV2;
1903
- export type JourneyFeatureFlags = Components.Schemas.JourneyFeatureFlags;
1904
- export type JourneyProductsResponse = Components.Schemas.JourneyProductsResponse;
1905
- export type JourneyResponse = Components.Schemas.JourneyResponse;
1906
- export type JourneyValidationError = Components.Schemas.JourneyValidationError;
1907
- export type JourneyValidationResponse = Components.Schemas.JourneyValidationResponse;
1908
- export type PatchUpdateJourneyRequest = Components.Schemas.PatchUpdateJourneyRequest;
1909
- export type RuleRef = Components.Schemas.RuleRef;
1910
- export type S3Reference = Components.Schemas.S3Reference;
1911
- export type SearchJourneysQueryRequest = Components.Schemas.SearchJourneysQueryRequest;
1912
- export type SearchJourneysResponse = Components.Schemas.SearchJourneysResponse;
1913
- export type TemplateSettings = Components.Schemas.TemplateSettings;
1914
- export type ValidationRuleRef = Components.Schemas.ValidationRuleRef;