@epilot/journey-client 0.1.3 → 0.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/openapi.d.ts CHANGED
@@ -9,17 +9,13 @@ import type {
9
9
 
10
10
  declare namespace Components {
11
11
  namespace Schemas {
12
- export type CommissioningJourneyQueryRequest = {
13
- organization_id: number;
14
- branches: ("commissioning_power" | "commissioning_gas" | "commissioning_water")[];
15
- }[];
16
12
  export interface GetJourneysResponse {
17
13
  }
18
14
  export interface JourneyCreationRequest {
19
15
  [name: string]: any;
20
16
  journeyId?: string;
21
17
  organizationId: string;
22
- brandId: string;
18
+ brandId?: string;
23
19
  name: string;
24
20
  steps: {
25
21
  showStepName?: boolean | null;
@@ -54,6 +50,7 @@ declare namespace Components {
54
50
  settings?: {
55
51
  embedOptions?: {
56
52
  mode?: "full-screen" | "inline";
53
+ lang?: "de" | "en" | "fr";
57
54
  width?: string;
58
55
  topBar?: boolean;
59
56
  scrollToTop?: boolean;
@@ -62,164 +59,54 @@ declare namespace Components {
62
59
  align?: "left" | "center" | "right";
63
60
  };
64
61
  };
62
+ safeModeAutomation?: boolean;
65
63
  designId: string;
66
64
  templateId?: string;
67
- entityId?: string;
65
+ entityId?: string | null;
68
66
  mappingsAutomationId?: string;
69
- targeted_customer?: string;
70
67
  targetedCustomer?: string;
71
68
  description?: string | null;
72
69
  organizationSettings?: {
73
70
  [name: string]: boolean;
74
71
  } | null;
72
+ publicToken?: string | null;
75
73
  runtimeEntities?: ("ORDER" | "OPPORTUNITY")[];
74
+ filePurposes?: string[];
75
+ entityTags?: string[];
76
+ addressSuggestionsFileUrl?: string | null;
76
77
  };
77
78
  createdBy?: string;
78
79
  }
79
- export interface JourneyResponse {
80
- }
81
- export interface JourneyStepTemplateCreationRequest {
82
- [name: string]: any;
83
- templateId?: string;
84
- name: string;
85
- description?: string;
86
- schema: any;
87
- uischema: any;
88
- settings: {
89
- showStepName?: boolean | null;
90
- title?: string | null;
91
- subTitle?: string | null;
92
- showStepSubtitle?: boolean | null;
93
- showStepper?: boolean | null;
94
- showStepperLabels?: boolean | null;
95
- hideNextButton?: boolean | null;
96
- };
97
- createdBy?: string;
98
- }
99
- export interface JourneyStepTemplateUpdateRequest {
100
- [name: string]: any;
101
- templateId: string;
80
+ export type JourneyProductsResponse = {
81
+ type?: string;
82
+ _schema?: string;
83
+ _title?: string;
102
84
  name?: string;
85
+ _id?: string;
86
+ _org?: string;
87
+ code?: string;
103
88
  description?: string;
104
- schema?: any;
105
- uischema?: any;
106
- settings?: {
107
- showStepName?: boolean | null;
108
- title?: string | null;
109
- subTitle?: string | null;
110
- showStepSubtitle?: boolean | null;
111
- showStepper?: boolean | null;
112
- showStepperLabels?: boolean | null;
113
- hideNextButton?: boolean | null;
114
- };
115
- }
116
- export interface JourneyTemplateCreationRequest {
117
- templateId?: string;
118
- name: string;
119
- steps: {
120
- showStepName?: boolean | null;
121
- title?: string | null;
122
- subTitle?: string | null;
123
- showStepSubtitle?: boolean | null;
124
- showStepper?: boolean | null;
125
- showStepperLabels?: boolean | null;
126
- hideNextButton?: boolean | null;
127
- name: string;
128
- stepId?: string;
129
- schema: any;
130
- uischema: any;
131
- }[];
132
- description?: string | null;
133
- rules?: {
134
- type: "inject" | "injectWithKey";
135
- sourceType: "journey" | "step" | "block";
136
- source: string;
137
- target: string;
138
- }[];
139
- logics?: {
140
- autoGeneratedId?: string;
141
- conditions: string[];
142
- actions: string[];
143
- }[];
144
- createdBy?: string;
145
- tags?: string[];
146
- settings?: {
147
- runtimeEntities?: ("ORDER" | "OPPORTUNITY")[];
89
+ feature?: any[];
90
+ product_images?: any[];
91
+ legal_footnote?: string;
92
+ product_downloads?: any[];
93
+ price?: {
94
+ [key: string]: any;
148
95
  };
96
+ }[];
97
+ export interface JourneyResponse {
149
98
  }
150
- export interface JourneyTemplateUpdateRequest {
99
+ /**
100
+ * Patch request to update a journey (journey id is required) Support for nested properties (e.g. steps[0].uischema.elements[0].products) is supported.
101
+ *
102
+ */
103
+ export interface PatchUpdateJourneyRequest {
151
104
  [name: string]: any;
152
- templateId: string;
153
- name?: string;
154
- steps?: {
155
- showStepName?: boolean | null;
156
- title?: string | null;
157
- subTitle?: string | null;
158
- showStepSubtitle?: boolean | null;
159
- showStepper?: boolean | null;
160
- showStepperLabels?: boolean | null;
161
- hideNextButton?: boolean | null;
162
- name: string;
163
- stepId?: string;
164
- schema: any;
165
- uischema: any;
166
- }[];
167
- description?: string | null;
168
- rules?: {
169
- type: "inject" | "injectWithKey";
170
- sourceType: "journey" | "step" | "block";
171
- source: string;
172
- target: string;
173
- }[];
174
- logics?: {
175
- autoGeneratedId?: string;
176
- conditions: string[];
177
- actions: string[];
178
- }[];
179
- tags?: string[];
180
- settings?: {
181
- runtimeEntities?: ("ORDER" | "OPPORTUNITY")[];
182
- };
183
- }
184
- export interface PersistFilesRequest {
185
- files: {
186
- bucket: string;
187
- key: string;
188
- fileName?: string;
189
- }[];
190
- }
191
- export interface SearchJourneyTemplatesQueryRequest {
192
- /**
193
- * Lucene query syntax
194
- * See https://lucene.apache.org/core/2_9_4/queryparsersyntax.html ; https://www.elastic.co/guide/en/kibana/current/lucene-query.html
195
- *
196
- * example:
197
- * *template* OR *test*
198
- */
199
- q?: string;
200
- /**
201
- * The offset of the first result to return.
202
- * See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html
203
- *
204
- * example:
205
- * 0
206
- */
207
- from?: number;
208
- /**
209
- * The maximum number of results to return.
210
- * See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html
211
- *
212
- * example:
213
- * 10
214
- */
215
- size?: number;
216
105
  /**
217
- * The sort order. Follows Lucene syntax.
218
- *
219
106
  * example:
220
- * lastModifiedAt:desc
107
+ * 509cdffe-424f-457a-95c2-9708c304ce77
221
108
  */
222
- sort?: string;
109
+ journeyId: string; // uuid
223
110
  }
224
111
  export interface SearchJourneysQueryRequest {
225
112
  /**
@@ -227,7 +114,7 @@ declare namespace Components {
227
114
  * See https://lucene.apache.org/core/2_9_4/queryparsersyntax.html ; https://www.elastic.co/guide/en/kibana/current/lucene-query.html
228
115
  *
229
116
  * example:
230
- * *journey* OR *test*
117
+ * _tags:*Flex*
231
118
  */
232
119
  q?: string;
233
120
  /**
@@ -243,14 +130,14 @@ declare namespace Components {
243
130
  * See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html
244
131
  *
245
132
  * example:
246
- * 10
133
+ * 25
247
134
  */
248
135
  size?: number;
249
136
  /**
250
137
  * The sort order. Follows Lucene syntax.
251
138
  *
252
139
  * example:
253
- * lastModifiedAt:desc
140
+ * _created_at:desc
254
141
  */
255
142
  sort?: string;
256
143
  }
@@ -268,113 +155,78 @@ declare namespace Components {
268
155
  */
269
156
  results?: {
270
157
  /**
158
+ * Journey Entity ID
271
159
  * example:
272
160
  * e0f8f8f8-f8f8-f8f8-f8f8-f8f8f8f8f8f8
273
161
  */
274
- journeyId?: string; // uuid
162
+ _id?: string; // uuid
275
163
  /**
276
- * The type of journey.
277
- * v2: Old Journey
278
- * v3: New Journey
279
- *
164
+ * Entity Schema (journey always in this case)
280
165
  * example:
281
- * v2
166
+ * journey
282
167
  */
283
- type?: "v2" | "v3";
168
+ _schema?: string;
284
169
  /**
170
+ * Journey Entity Title
285
171
  * example:
286
- * My Journey
172
+ * Journey Entity Title
287
173
  */
288
- name?: string;
174
+ _title?: string;
289
175
  /**
176
+ * Organization ID
290
177
  * example:
291
178
  * 739224
292
179
  */
293
- organizationId?: string;
180
+ _org?: string;
294
181
  /**
295
182
  * example:
296
- * 739225
183
+ * 2020-01-01T00:00:00.000Z
297
184
  */
298
- brandId?: string;
185
+ _created_at?: string; // date-time
299
186
  /**
300
187
  * example:
301
188
  * 2020-01-01T00:00:00.000Z
302
189
  */
303
- createdAt?: string; // date-time
190
+ _updated_at?: string; // date-time
191
+ _tags?: string[];
304
192
  /**
193
+ * Journey Name
305
194
  * example:
306
- * 2020-01-01T00:00:00.000Z
195
+ * Journey Name
307
196
  */
308
- lastModifiedAt?: string; // date-time
197
+ journey_name?: string;
309
198
  /**
199
+ * Journey config ID
310
200
  * example:
311
- * 12345
201
+ * de7df470-253e-11ed-9174-116b8a718c0a
312
202
  */
313
- createdBy?: string;
314
- settings?: {
315
- /**
316
- * example:
317
- * My Journey Description
318
- */
319
- description?: string;
320
- /**
321
- * example:
322
- * 99999999-9999-9999-9999-999999999999
323
- */
324
- templatedId?: string;
203
+ journey_id?: string; // uuid
204
+ /**
205
+ * Journey Template
206
+ * example:
207
+ * Sales template
208
+ */
209
+ journey_type?: string;
210
+ /**
211
+ * Journey Design Name
212
+ * example:
213
+ * Design EPILOT
214
+ */
215
+ design?: string;
216
+ created_by?: {
325
217
  /**
218
+ * User ID
326
219
  * example:
327
- * My Journey Category
220
+ * 12345
328
221
  */
329
- category?: string;
330
- };
222
+ id?: string;
223
+ }[];
224
+ /**
225
+ * Journey Version
226
+ */
227
+ journey_version?: "Flex" | "Widget";
331
228
  }[];
332
229
  }
333
- export interface Widget {
334
- [name: string]: any;
335
- widgetId?: string;
336
- organizationId: string;
337
- name?: string;
338
- initialStepId?: string;
339
- styling?: {
340
- [name: string]: any;
341
- theming_options?: {
342
- [name: string]: any;
343
- };
344
- };
345
- shop?: any;
346
- steps?: any[];
347
- results?: any;
348
- builder?: {
349
- [name: string]: any;
350
- name?: string;
351
- description?: string;
352
- category?: string;
353
- bundle_category?: string;
354
- brand_id: string | number;
355
- style_id?: string;
356
- entity_id?: string;
357
- template_id?: string;
358
- steps?: {
359
- [name: string]: {
360
- [name: string]: any;
361
- };
362
- };
363
- created_by?: string;
364
- created_at?: string; // date-time
365
- last_modified_by?: string;
366
- last_modified_at?: string; // date-time
367
- active?: boolean;
368
- selected_products?: string[];
369
- selected_addons?: string[];
370
- enable_automation_email?: boolean;
371
- email_template_id?: string | number;
372
- targets?: string[];
373
- useBaseElementsLibrary?: boolean;
374
- };
375
- last_modified_at?: string;
376
- created_at?: string;
377
- }
378
230
  }
379
231
  }
380
232
  declare namespace Paths {
@@ -384,37 +236,6 @@ declare namespace Paths {
384
236
  export type $201 = Components.Schemas.JourneyResponse;
385
237
  }
386
238
  }
387
- namespace CreateJourneyStepTemplate {
388
- export type RequestBody = Components.Schemas.JourneyStepTemplateCreationRequest;
389
- }
390
- namespace CreateJourneyTemplate {
391
- export type RequestBody = Components.Schemas.JourneyTemplateCreationRequest;
392
- }
393
- namespace CreateWidget {
394
- export type RequestBody = Components.Schemas.Widget;
395
- }
396
- namespace FilesPersist {
397
- export type RequestBody = Components.Schemas.PersistFilesRequest;
398
- }
399
- namespace GetCraftsmenJourneys {
400
- export type RequestBody = Components.Schemas.CommissioningJourneyQueryRequest;
401
- }
402
- namespace GetEmailTemplates {
403
- namespace Parameters {
404
- /**
405
- * example:
406
- * 123
407
- */
408
- export type Id = string;
409
- }
410
- export interface PathParameters {
411
- id: /**
412
- * example:
413
- * 123
414
- */
415
- Parameters.Id;
416
- }
417
- }
418
239
  namespace GetJourney {
419
240
  namespace Parameters {
420
241
  /**
@@ -440,13 +261,19 @@ declare namespace Paths {
440
261
  export type $200 = Components.Schemas.JourneyResponse;
441
262
  }
442
263
  }
443
- namespace GetJourneyStepTemplateById {
264
+ namespace GetJourneyProducts {
444
265
  namespace Parameters {
266
+ export type City = string;
445
267
  /**
446
268
  * example:
447
269
  * 509cdffe-424f-457a-95c2-9708c304ce77
448
270
  */
449
271
  export type Id = string; // uuid
272
+ export type OrgId = string;
273
+ export type PostalCode = string;
274
+ export type Source = string;
275
+ export type Street = string;
276
+ export type StreetNumber = string;
450
277
  }
451
278
  export interface PathParameters {
452
279
  id: /**
@@ -455,21 +282,16 @@ declare namespace Paths {
455
282
  */
456
283
  Parameters.Id /* uuid */;
457
284
  }
458
- }
459
- namespace GetJourneyTemplateById {
460
- namespace Parameters {
461
- /**
462
- * example:
463
- * 509cdffe-424f-457a-95c2-9708c304ce77
464
- */
465
- export type Id = string; // uuid
285
+ export interface QueryParameters {
286
+ source?: Parameters.Source;
287
+ orgId?: Parameters.OrgId;
288
+ postal_code?: Parameters.PostalCode;
289
+ city?: Parameters.City;
290
+ street?: Parameters.Street;
291
+ street_number?: Parameters.StreetNumber;
466
292
  }
467
- export interface PathParameters {
468
- id: /**
469
- * example:
470
- * 509cdffe-424f-457a-95c2-9708c304ce77
471
- */
472
- Parameters.Id /* uuid */;
293
+ namespace Responses {
294
+ export type $200 = Components.Schemas.JourneyProductsResponse;
473
295
  }
474
296
  }
475
297
  namespace GetJourneysByOrgId {
@@ -491,28 +313,14 @@ declare namespace Paths {
491
313
  export type $200 = Components.Schemas.GetJourneysResponse;
492
314
  }
493
315
  }
494
- namespace GetWidget {
495
- namespace Parameters {
496
- /**
497
- * example:
498
- * 509cdffe-424f-457a-95c2-9708c304ce77
499
- */
500
- export type Id = string; // uuid
501
- export type OrgId = string;
502
- export type Source = string;
503
- export type Version = number;
504
- }
505
- export interface PathParameters {
506
- id: /**
507
- * example:
508
- * 509cdffe-424f-457a-95c2-9708c304ce77
509
- */
510
- Parameters.Id /* uuid */;
511
- }
512
- export interface QueryParameters {
513
- version?: Parameters.Version;
514
- source?: Parameters.Source;
515
- orgId?: Parameters.OrgId;
316
+ namespace PatchUpdateJourney {
317
+ export type RequestBody = /**
318
+ * Patch request to update a journey (journey id is required) Support for nested properties (e.g. steps[0].uischema.elements[0].products) is supported.
319
+ *
320
+ */
321
+ Components.Schemas.PatchUpdateJourneyRequest;
322
+ namespace Responses {
323
+ export type $200 = Components.Schemas.JourneyResponse;
516
324
  }
517
325
  }
518
326
  namespace RemoveJourney {
@@ -531,102 +339,18 @@ declare namespace Paths {
531
339
  Parameters.Id /* uuid */;
532
340
  }
533
341
  }
534
- namespace RemoveJourneyStepTemplate {
535
- namespace Parameters {
536
- /**
537
- * example:
538
- * 509cdffe-424f-457a-95c2-9708c304ce77
539
- */
540
- export type Id = string; // uuid
541
- }
542
- export interface PathParameters {
543
- id: /**
544
- * example:
545
- * 509cdffe-424f-457a-95c2-9708c304ce77
546
- */
547
- Parameters.Id /* uuid */;
548
- }
549
- }
550
- namespace RemoveJourneyTemplate {
551
- namespace Parameters {
552
- /**
553
- * example:
554
- * 509cdffe-424f-457a-95c2-9708c304ce77
555
- */
556
- export type Id = string; // uuid
557
- }
558
- export interface PathParameters {
559
- id: /**
560
- * example:
561
- * 509cdffe-424f-457a-95c2-9708c304ce77
562
- */
563
- Parameters.Id /* uuid */;
564
- }
565
- }
566
- namespace RemoveWidget {
567
- namespace Parameters {
568
- /**
569
- * example:
570
- * 509cdffe-424f-457a-95c2-9708c304ce77
571
- */
572
- export type Id = string; // uuid
573
- }
574
- export interface PathParameters {
575
- id: /**
576
- * example:
577
- * 509cdffe-424f-457a-95c2-9708c304ce77
578
- */
579
- Parameters.Id /* uuid */;
580
- }
581
- }
582
- namespace RemoveWidgets {
583
- namespace Parameters {
584
- export type WidgetId = string[];
585
- }
586
- export interface QueryParameters {
587
- widgetId: Parameters.WidgetId;
588
- }
589
- }
590
- namespace SearchJourneyTemplates {
591
- export type RequestBody = Components.Schemas.SearchJourneyTemplatesQueryRequest;
592
- }
593
342
  namespace SearchJourneys {
594
343
  export type RequestBody = Components.Schemas.SearchJourneysQueryRequest;
595
344
  namespace Responses {
596
345
  export type $200 = Components.Schemas.SearchJourneysResponse;
597
346
  }
598
347
  }
599
- namespace SearchWidgetByOrganizationId {
600
- namespace Parameters {
601
- /**
602
- * example:
603
- * 123
604
- */
605
- export type Id = string;
606
- }
607
- export interface PathParameters {
608
- id: /**
609
- * example:
610
- * 123
611
- */
612
- Parameters.Id;
613
- }
614
- }
615
348
  namespace UpdateJourney {
616
349
  export type RequestBody = Components.Schemas.JourneyCreationRequest;
617
350
  namespace Responses {
618
351
  export type $200 = Components.Schemas.JourneyResponse;
619
352
  }
620
353
  }
621
- namespace UpdateJourneyStepTemplate {
622
- export type RequestBody = Components.Schemas.JourneyStepTemplateCreationRequest;
623
- }
624
- namespace UpdateJourneyTemplate {
625
- export type RequestBody = Components.Schemas.JourneyTemplateUpdateRequest;
626
- }
627
- namespace UpdateWidget {
628
- export type RequestBody = Components.Schemas.Widget;
629
- }
630
354
  }
631
355
 
632
356
  export interface OperationMethods {
@@ -660,6 +384,16 @@ export interface OperationMethods {
660
384
  data?: any,
661
385
  config?: AxiosRequestConfig
662
386
  ): OperationResponse<any>
387
+ /**
388
+ * getJourneyProducts - getJourneyProducts
389
+ *
390
+ * Get products available in the journey by id
391
+ */
392
+ 'getJourneyProducts'(
393
+ parameters?: Parameters<Paths.GetJourneyProducts.PathParameters & Paths.GetJourneyProducts.QueryParameters> | null,
394
+ data?: any,
395
+ config?: AxiosRequestConfig
396
+ ): OperationResponse<Paths.GetJourneyProducts.Responses.$200>
663
397
  /**
664
398
  * updateJourney - updateJourney
665
399
  *
@@ -681,195 +415,15 @@ export interface OperationMethods {
681
415
  config?: AxiosRequestConfig
682
416
  ): OperationResponse<Paths.CreateJourney.Responses.$201>
683
417
  /**
684
- * getJourneysTemplates - getJourneysTemplates
685
- *
686
- * Get All Journey Templates
687
- */
688
- 'getJourneysTemplates'(
689
- parameters?: Parameters<UnknownParamsObject> | null,
690
- data?: any,
691
- config?: AxiosRequestConfig
692
- ): OperationResponse<any>
693
- /**
694
- * createJourneyTemplate - createJourneyTemplate
695
- *
696
- * Get a new Journey Template
697
- */
698
- 'createJourneyTemplate'(
699
- parameters?: Parameters<UnknownParamsObject> | null,
700
- data?: Paths.CreateJourneyTemplate.RequestBody,
701
- config?: AxiosRequestConfig
702
- ): OperationResponse<any>
703
- /**
704
- * updateJourneyTemplate - updateJourneyTemplate
705
- *
706
- * Update a Journey Template
707
- */
708
- 'updateJourneyTemplate'(
709
- parameters?: Parameters<UnknownParamsObject> | null,
710
- data?: Paths.UpdateJourneyTemplate.RequestBody,
711
- config?: AxiosRequestConfig
712
- ): OperationResponse<any>
713
- /**
714
- * getJourneyTemplateById - getJourneyTemplateById
715
- *
716
- * Get Journey Template by ID
717
- */
718
- 'getJourneyTemplateById'(
719
- parameters?: Parameters<Paths.GetJourneyTemplateById.PathParameters> | null,
720
- data?: any,
721
- config?: AxiosRequestConfig
722
- ): OperationResponse<any>
723
- /**
724
- * removeJourneyTemplate - removeJourneyTemplate
725
- *
726
- * Remove Journey Template by id
727
- */
728
- 'removeJourneyTemplate'(
729
- parameters?: Parameters<Paths.RemoveJourneyTemplate.PathParameters> | null,
730
- data?: any,
731
- config?: AxiosRequestConfig
732
- ): OperationResponse<any>
733
- /**
734
- * searchJourneyTemplates - searchJourneyTemplates
735
- *
736
- * Search Journey Templates
737
- */
738
- 'searchJourneyTemplates'(
739
- parameters?: Parameters<UnknownParamsObject> | null,
740
- data?: Paths.SearchJourneyTemplates.RequestBody,
741
- config?: AxiosRequestConfig
742
- ): OperationResponse<any>
743
- /**
744
- * getJourneyStepTemplateById - getJourneyStepTemplateById
745
- *
746
- * Get Journey Step Template by ID
747
- */
748
- 'getJourneyStepTemplateById'(
749
- parameters?: Parameters<Paths.GetJourneyStepTemplateById.PathParameters> | null,
750
- data?: any,
751
- config?: AxiosRequestConfig
752
- ): OperationResponse<any>
753
- /**
754
- * removeJourneyStepTemplate - removeJourneyStepTemplate
755
- *
756
- * Delete Journey Step Template
757
- */
758
- 'removeJourneyStepTemplate'(
759
- parameters?: Parameters<Paths.RemoveJourneyStepTemplate.PathParameters> | null,
760
- data?: any,
761
- config?: AxiosRequestConfig
762
- ): OperationResponse<any>
763
- /**
764
- * getJourneysStepTemplates - getJourneysStepTemplates
765
- *
766
- * Get All Journey Step Templates
767
- */
768
- 'getJourneysStepTemplates'(
769
- parameters?: Parameters<UnknownParamsObject> | null,
770
- data?: any,
771
- config?: AxiosRequestConfig
772
- ): OperationResponse<any>
773
- /**
774
- * createJourneyStepTemplate - createJourneyStepTemplate
775
- *
776
- * Create a new journey step template
777
- */
778
- 'createJourneyStepTemplate'(
779
- parameters?: Parameters<UnknownParamsObject> | null,
780
- data?: Paths.CreateJourneyStepTemplate.RequestBody,
781
- config?: AxiosRequestConfig
782
- ): OperationResponse<any>
783
- /**
784
- * updateJourneyStepTemplate - updateJourneyStepTemplate
418
+ * patchUpdateJourney - patchUpdateJourney
785
419
  *
786
- * Update a journey step template
420
+ * Update a Journey (partially / patch). Support for nested properties updates (e.g. "property[0].name").
787
421
  */
788
- 'updateJourneyStepTemplate'(
422
+ 'patchUpdateJourney'(
789
423
  parameters?: Parameters<UnknownParamsObject> | null,
790
- data?: Paths.UpdateJourneyStepTemplate.RequestBody,
424
+ data?: Paths.PatchUpdateJourney.RequestBody,
791
425
  config?: AxiosRequestConfig
792
- ): OperationResponse<any>
793
- /**
794
- * getWidget - getWidget
795
- *
796
- * Get Widget by ID
797
- */
798
- 'getWidget'(
799
- parameters?: Parameters<Paths.GetWidget.PathParameters & Paths.GetWidget.QueryParameters> | null,
800
- data?: any,
801
- config?: AxiosRequestConfig
802
- ): OperationResponse<any>
803
- /**
804
- * removeWidget - removeWidget
805
- *
806
- * Remove widget by id
807
- */
808
- 'removeWidget'(
809
- parameters?: Parameters<Paths.RemoveWidget.PathParameters> | null,
810
- data?: any,
811
- config?: AxiosRequestConfig
812
- ): OperationResponse<any>
813
- /**
814
- * getCraftsmenJourneys - getCraftsmenJourneys
815
- *
816
- * Get craftsmen Journeys
817
- */
818
- 'getCraftsmenJourneys'(
819
- parameters?: Parameters<UnknownParamsObject> | null,
820
- data?: Paths.GetCraftsmenJourneys.RequestBody,
821
- config?: AxiosRequestConfig
822
- ): OperationResponse<any>
823
- /**
824
- * getEmailTemplates - getEmailTemplates
825
- *
826
- * Get email templates for organization
827
- */
828
- 'getEmailTemplates'(
829
- parameters?: Parameters<Paths.GetEmailTemplates.PathParameters> | null,
830
- data?: any,
831
- config?: AxiosRequestConfig
832
- ): OperationResponse<any>
833
- /**
834
- * searchWidgetByOrganizationId - searchWidgetByOrganizationId
835
- *
836
- * Search widgets by organization ID
837
- */
838
- 'searchWidgetByOrganizationId'(
839
- parameters?: Parameters<Paths.SearchWidgetByOrganizationId.PathParameters> | null,
840
- data?: any,
841
- config?: AxiosRequestConfig
842
- ): OperationResponse<any>
843
- /**
844
- * updateWidget - updateWidget
845
- *
846
- * Update a widget
847
- */
848
- 'updateWidget'(
849
- parameters?: Parameters<UnknownParamsObject> | null,
850
- data?: Paths.UpdateWidget.RequestBody,
851
- config?: AxiosRequestConfig
852
- ): OperationResponse<any>
853
- /**
854
- * createWidget - createWidget
855
- *
856
- * Create new Widget
857
- */
858
- 'createWidget'(
859
- parameters?: Parameters<UnknownParamsObject> | null,
860
- data?: Paths.CreateWidget.RequestBody,
861
- config?: AxiosRequestConfig
862
- ): OperationResponse<any>
863
- /**
864
- * removeWidgets - removeWidgets
865
- *
866
- * Remove widgets
867
- */
868
- 'removeWidgets'(
869
- parameters?: Parameters<Paths.RemoveWidgets.QueryParameters> | null,
870
- data?: any,
871
- config?: AxiosRequestConfig
872
- ): OperationResponse<any>
426
+ ): OperationResponse<Paths.PatchUpdateJourney.Responses.$200>
873
427
  /**
874
428
  * searchJourneys - searchJourneys
875
429
  *
@@ -880,17 +434,6 @@ export interface OperationMethods {
880
434
  data?: Paths.SearchJourneys.RequestBody,
881
435
  config?: AxiosRequestConfig
882
436
  ): OperationResponse<Paths.SearchJourneys.Responses.$200>
883
- /**
884
- * filesPersist - filesPersist
885
- *
886
- * This API is deprecated and will be removed. Please pass files directly via [Submission API](https://docs.epilot.io/api/submission/#tag/Submissions)
887
- *
888
- */
889
- 'filesPersist'(
890
- parameters?: Parameters<UnknownParamsObject> | null,
891
- data?: Paths.FilesPersist.RequestBody,
892
- config?: AxiosRequestConfig
893
- ): OperationResponse<any>
894
437
  }
895
438
 
896
439
  export interface PathsDictionary {
@@ -928,6 +471,18 @@ export interface PathsDictionary {
928
471
  config?: AxiosRequestConfig
929
472
  ): OperationResponse<any>
930
473
  }
474
+ ['/v1/journey/products/{id}']: {
475
+ /**
476
+ * getJourneyProducts - getJourneyProducts
477
+ *
478
+ * Get products available in the journey by id
479
+ */
480
+ 'get'(
481
+ parameters?: Parameters<Paths.GetJourneyProducts.PathParameters & Paths.GetJourneyProducts.QueryParameters> | null,
482
+ data?: any,
483
+ config?: AxiosRequestConfig
484
+ ): OperationResponse<Paths.GetJourneyProducts.Responses.$200>
485
+ }
931
486
  ['/v1/journey/configuration']: {
932
487
  /**
933
488
  * createJourney - createJourney
@@ -949,218 +504,16 @@ export interface PathsDictionary {
949
504
  data?: Paths.UpdateJourney.RequestBody,
950
505
  config?: AxiosRequestConfig
951
506
  ): OperationResponse<Paths.UpdateJourney.Responses.$200>
952
- }
953
- ['/v1/journey/templates']: {
954
- /**
955
- * updateJourneyTemplate - updateJourneyTemplate
956
- *
957
- * Update a Journey Template
958
- */
959
- 'patch'(
960
- parameters?: Parameters<UnknownParamsObject> | null,
961
- data?: Paths.UpdateJourneyTemplate.RequestBody,
962
- config?: AxiosRequestConfig
963
- ): OperationResponse<any>
964
- /**
965
- * getJourneysTemplates - getJourneysTemplates
966
- *
967
- * Get All Journey Templates
968
- */
969
- 'get'(
970
- parameters?: Parameters<UnknownParamsObject> | null,
971
- data?: any,
972
- config?: AxiosRequestConfig
973
- ): OperationResponse<any>
974
- /**
975
- * createJourneyTemplate - createJourneyTemplate
976
- *
977
- * Get a new Journey Template
978
- */
979
- 'post'(
980
- parameters?: Parameters<UnknownParamsObject> | null,
981
- data?: Paths.CreateJourneyTemplate.RequestBody,
982
- config?: AxiosRequestConfig
983
- ): OperationResponse<any>
984
- }
985
- ['/v1/journey/templates/{id}']: {
986
- /**
987
- * removeJourneyTemplate - removeJourneyTemplate
988
- *
989
- * Remove Journey Template by id
990
- */
991
- 'delete'(
992
- parameters?: Parameters<Paths.RemoveJourneyTemplate.PathParameters> | null,
993
- data?: any,
994
- config?: AxiosRequestConfig
995
- ): OperationResponse<any>
996
- /**
997
- * getJourneyTemplateById - getJourneyTemplateById
998
- *
999
- * Get Journey Template by ID
1000
- */
1001
- 'get'(
1002
- parameters?: Parameters<Paths.GetJourneyTemplateById.PathParameters> | null,
1003
- data?: any,
1004
- config?: AxiosRequestConfig
1005
- ): OperationResponse<any>
1006
- }
1007
- ['/v1/journey/templates/search']: {
1008
- /**
1009
- * searchJourneyTemplates - searchJourneyTemplates
1010
- *
1011
- * Search Journey Templates
1012
- */
1013
- 'post'(
1014
- parameters?: Parameters<UnknownParamsObject> | null,
1015
- data?: Paths.SearchJourneyTemplates.RequestBody,
1016
- config?: AxiosRequestConfig
1017
- ): OperationResponse<any>
1018
- }
1019
- ['/v1/journey/step/templates/{id}']: {
1020
- /**
1021
- * removeJourneyStepTemplate - removeJourneyStepTemplate
1022
- *
1023
- * Delete Journey Step Template
1024
- */
1025
- 'delete'(
1026
- parameters?: Parameters<Paths.RemoveJourneyStepTemplate.PathParameters> | null,
1027
- data?: any,
1028
- config?: AxiosRequestConfig
1029
- ): OperationResponse<any>
1030
- /**
1031
- * getJourneyStepTemplateById - getJourneyStepTemplateById
1032
- *
1033
- * Get Journey Step Template by ID
1034
- */
1035
- 'get'(
1036
- parameters?: Parameters<Paths.GetJourneyStepTemplateById.PathParameters> | null,
1037
- data?: any,
1038
- config?: AxiosRequestConfig
1039
- ): OperationResponse<any>
1040
- }
1041
- ['/v1/journey/step/templates']: {
1042
- /**
1043
- * getJourneysStepTemplates - getJourneysStepTemplates
1044
- *
1045
- * Get All Journey Step Templates
1046
- */
1047
- 'get'(
1048
- parameters?: Parameters<UnknownParamsObject> | null,
1049
- data?: any,
1050
- config?: AxiosRequestConfig
1051
- ): OperationResponse<any>
1052
- /**
1053
- * createJourneyStepTemplate - createJourneyStepTemplate
1054
- *
1055
- * Create a new journey step template
1056
- */
1057
- 'post'(
1058
- parameters?: Parameters<UnknownParamsObject> | null,
1059
- data?: Paths.CreateJourneyStepTemplate.RequestBody,
1060
- config?: AxiosRequestConfig
1061
- ): OperationResponse<any>
1062
507
  /**
1063
- * updateJourneyStepTemplate - updateJourneyStepTemplate
508
+ * patchUpdateJourney - patchUpdateJourney
1064
509
  *
1065
- * Update a journey step template
510
+ * Update a Journey (partially / patch). Support for nested properties updates (e.g. "property[0].name").
1066
511
  */
1067
512
  'patch'(
1068
513
  parameters?: Parameters<UnknownParamsObject> | null,
1069
- data?: Paths.UpdateJourneyStepTemplate.RequestBody,
514
+ data?: Paths.PatchUpdateJourney.RequestBody,
1070
515
  config?: AxiosRequestConfig
1071
- ): OperationResponse<any>
1072
- }
1073
- ['/v1/widget/configuration/{id}']: {
1074
- /**
1075
- * getWidget - getWidget
1076
- *
1077
- * Get Widget by ID
1078
- */
1079
- 'get'(
1080
- parameters?: Parameters<Paths.GetWidget.PathParameters & Paths.GetWidget.QueryParameters> | null,
1081
- data?: any,
1082
- config?: AxiosRequestConfig
1083
- ): OperationResponse<any>
1084
- /**
1085
- * removeWidget - removeWidget
1086
- *
1087
- * Remove widget by id
1088
- */
1089
- 'delete'(
1090
- parameters?: Parameters<Paths.RemoveWidget.PathParameters> | null,
1091
- data?: any,
1092
- config?: AxiosRequestConfig
1093
- ): OperationResponse<any>
1094
- }
1095
- ['/v1/widget/craftsmen']: {
1096
- /**
1097
- * getCraftsmenJourneys - getCraftsmenJourneys
1098
- *
1099
- * Get craftsmen Journeys
1100
- */
1101
- 'post'(
1102
- parameters?: Parameters<UnknownParamsObject> | null,
1103
- data?: Paths.GetCraftsmenJourneys.RequestBody,
1104
- config?: AxiosRequestConfig
1105
- ): OperationResponse<any>
1106
- }
1107
- ['/v1/widget/email-templates/{id}']: {
1108
- /**
1109
- * getEmailTemplates - getEmailTemplates
1110
- *
1111
- * Get email templates for organization
1112
- */
1113
- 'get'(
1114
- parameters?: Parameters<Paths.GetEmailTemplates.PathParameters> | null,
1115
- data?: any,
1116
- config?: AxiosRequestConfig
1117
- ): OperationResponse<any>
1118
- }
1119
- ['/v1/widget/organization/{id}']: {
1120
- /**
1121
- * searchWidgetByOrganizationId - searchWidgetByOrganizationId
1122
- *
1123
- * Search widgets by organization ID
1124
- */
1125
- 'get'(
1126
- parameters?: Parameters<Paths.SearchWidgetByOrganizationId.PathParameters> | null,
1127
- data?: any,
1128
- config?: AxiosRequestConfig
1129
- ): OperationResponse<any>
1130
- }
1131
- ['/v1/widget/configuration']: {
1132
- /**
1133
- * createWidget - createWidget
1134
- *
1135
- * Create new Widget
1136
- */
1137
- 'post'(
1138
- parameters?: Parameters<UnknownParamsObject> | null,
1139
- data?: Paths.CreateWidget.RequestBody,
1140
- config?: AxiosRequestConfig
1141
- ): OperationResponse<any>
1142
- /**
1143
- * updateWidget - updateWidget
1144
- *
1145
- * Update a widget
1146
- */
1147
- 'put'(
1148
- parameters?: Parameters<UnknownParamsObject> | null,
1149
- data?: Paths.UpdateWidget.RequestBody,
1150
- config?: AxiosRequestConfig
1151
- ): OperationResponse<any>
1152
- }
1153
- ['/v1/widget/configuration/delete']: {
1154
- /**
1155
- * removeWidgets - removeWidgets
1156
- *
1157
- * Remove widgets
1158
- */
1159
- 'delete'(
1160
- parameters?: Parameters<Paths.RemoveWidgets.QueryParameters> | null,
1161
- data?: any,
1162
- config?: AxiosRequestConfig
1163
- ): OperationResponse<any>
516
+ ): OperationResponse<Paths.PatchUpdateJourney.Responses.$200>
1164
517
  }
1165
518
  ['/v1/journey/configuration/search']: {
1166
519
  /**
@@ -1174,19 +527,6 @@ export interface PathsDictionary {
1174
527
  config?: AxiosRequestConfig
1175
528
  ): OperationResponse<Paths.SearchJourneys.Responses.$200>
1176
529
  }
1177
- ['/v1/journey/files/persist']: {
1178
- /**
1179
- * filesPersist - filesPersist
1180
- *
1181
- * This API is deprecated and will be removed. Please pass files directly via [Submission API](https://docs.epilot.io/api/submission/#tag/Submissions)
1182
- *
1183
- */
1184
- 'post'(
1185
- parameters?: Parameters<UnknownParamsObject> | null,
1186
- data?: Paths.FilesPersist.RequestBody,
1187
- config?: AxiosRequestConfig
1188
- ): OperationResponse<any>
1189
- }
1190
530
  }
1191
531
 
1192
532
  export type Client = OpenAPIClient<OperationMethods, PathsDictionary>