@epilot/journey-client 0.1.4 → 0.1.6

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
- export interface JourneyCreationRequest {
14
+ export interface Journey {
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;
@@ -68,57 +64,34 @@ declare namespace Components {
68
64
  templateId?: string;
69
65
  entityId?: string | null;
70
66
  mappingsAutomationId?: string;
71
- targeted_customer?: string;
72
67
  targetedCustomer?: string;
73
68
  description?: string | null;
74
69
  organizationSettings?: {
75
70
  [name: string]: boolean;
76
71
  } | null;
72
+ publicToken?: string | null;
77
73
  runtimeEntities?: ("ORDER" | "OPPORTUNITY")[];
74
+ filePurposes?: string[];
75
+ entityTags?: string[];
76
+ addressSuggestionsFileUrl?: string | null;
78
77
  };
79
78
  createdBy?: string;
79
+ createdAt: string;
80
+ lastModifiedAt: string;
81
+ version: number;
82
+ revisions: number;
80
83
  }
81
- export interface JourneyResponse {
82
- }
83
- export interface JourneyStepTemplateCreationRequest {
84
- [name: string]: any;
85
- templateId?: string;
86
- name: string;
87
- description?: string;
88
- schema: any;
89
- uischema: any;
90
- settings: {
91
- safeModeAutomation?: boolean;
92
- showStepName?: boolean | null;
93
- title?: string | null;
94
- subTitle?: string | null;
95
- showStepSubtitle?: boolean | null;
96
- showStepper?: boolean | null;
97
- showStepperLabels?: boolean | null;
98
- hideNextButton?: boolean | null;
99
- };
100
- createdBy?: string;
84
+ export interface JourneyAuditInfo {
85
+ createdAt: string;
86
+ lastModifiedAt: string;
87
+ version: number;
88
+ revisions: number;
101
89
  }
102
- export interface JourneyStepTemplateUpdateRequest {
90
+ export interface JourneyCreationRequest {
103
91
  [name: string]: any;
104
- templateId: string;
105
- name?: string;
106
- description?: string;
107
- schema?: any;
108
- uischema?: any;
109
- settings?: {
110
- safeModeAutomation?: boolean;
111
- showStepName?: boolean | null;
112
- title?: string | null;
113
- subTitle?: string | null;
114
- showStepSubtitle?: boolean | null;
115
- showStepper?: boolean | null;
116
- showStepperLabels?: boolean | null;
117
- hideNextButton?: boolean | null;
118
- };
119
- }
120
- export interface JourneyTemplateCreationRequest {
121
- templateId?: string;
92
+ journeyId?: string;
93
+ organizationId: string;
94
+ brandId?: string;
122
95
  name: string;
123
96
  steps: {
124
97
  showStepName?: boolean | null;
@@ -133,7 +106,12 @@ declare namespace Components {
133
106
  schema: any;
134
107
  uischema: any;
135
108
  }[];
136
- description?: string | null;
109
+ design?: {
110
+ logoUrl?: string | null;
111
+ theme: {
112
+ [name: string]: any;
113
+ };
114
+ };
137
115
  rules?: {
138
116
  type: "inject" | "injectWithKey";
139
117
  sourceType: "journey" | "step" | "block";
@@ -145,87 +123,67 @@ declare namespace Components {
145
123
  conditions: string[];
146
124
  actions: string[];
147
125
  }[];
148
- createdBy?: string;
149
- tags?: string[];
150
126
  settings?: {
127
+ embedOptions?: {
128
+ mode?: "full-screen" | "inline";
129
+ lang?: "de" | "en" | "fr";
130
+ width?: string;
131
+ topBar?: boolean;
132
+ scrollToTop?: boolean;
133
+ button?: {
134
+ text?: string | null;
135
+ align?: "left" | "center" | "right";
136
+ };
137
+ };
151
138
  safeModeAutomation?: boolean;
139
+ designId: string;
140
+ templateId?: string;
141
+ entityId?: string | null;
142
+ mappingsAutomationId?: string;
143
+ targetedCustomer?: string;
144
+ description?: string | null;
145
+ organizationSettings?: {
146
+ [name: string]: boolean;
147
+ } | null;
148
+ publicToken?: string | null;
152
149
  runtimeEntities?: ("ORDER" | "OPPORTUNITY")[];
150
+ filePurposes?: string[];
151
+ entityTags?: string[];
152
+ addressSuggestionsFileUrl?: string | null;
153
153
  };
154
+ createdBy?: string;
154
155
  }
155
- export interface JourneyTemplateUpdateRequest {
156
- [name: string]: any;
157
- templateId: string;
156
+ export type JourneyProductsResponse = {
157
+ type?: string;
158
+ _schema?: string;
159
+ _title?: string;
158
160
  name?: string;
159
- steps?: {
160
- showStepName?: boolean | null;
161
- title?: string | null;
162
- subTitle?: string | null;
163
- showStepSubtitle?: boolean | null;
164
- showStepper?: boolean | null;
165
- showStepperLabels?: boolean | null;
166
- hideNextButton?: boolean | null;
167
- name: string;
168
- stepId?: string;
169
- schema: any;
170
- uischema: any;
171
- }[];
172
- description?: string | null;
173
- rules?: {
174
- type: "inject" | "injectWithKey";
175
- sourceType: "journey" | "step" | "block";
176
- source: string;
177
- target: string;
178
- }[];
179
- logics?: {
180
- autoGeneratedId?: string;
181
- conditions: string[];
182
- actions: string[];
183
- }[];
184
- tags?: string[];
185
- settings?: {
186
- safeModeAutomation?: boolean;
187
- runtimeEntities?: ("ORDER" | "OPPORTUNITY")[];
161
+ _id?: string;
162
+ _org?: string;
163
+ code?: string;
164
+ description?: string;
165
+ feature?: any[];
166
+ product_images?: any[];
167
+ legal_footnote?: string;
168
+ product_downloads?: any[];
169
+ price?: {
170
+ [key: string]: any;
188
171
  };
172
+ }[];
173
+ export interface JourneyResponse {
174
+ createdJourney?: Journey;
189
175
  }
190
- export interface PersistFilesRequest {
191
- files: {
192
- bucket: string;
193
- key: string;
194
- fileName?: string;
195
- }[];
196
- }
197
- export interface SearchJourneyTemplatesQueryRequest {
198
- /**
199
- * Lucene query syntax
200
- * See https://lucene.apache.org/core/2_9_4/queryparsersyntax.html ; https://www.elastic.co/guide/en/kibana/current/lucene-query.html
201
- *
202
- * example:
203
- * *template* OR *test*
204
- */
205
- q?: string;
206
- /**
207
- * The offset of the first result to return.
208
- * See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html
209
- *
210
- * example:
211
- * 0
212
- */
213
- from?: number;
214
- /**
215
- * The maximum number of results to return.
216
- * See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html
217
- *
218
- * example:
219
- * 10
220
- */
221
- size?: number;
176
+ /**
177
+ * Patch request to update a journey (journey id is required) Support for nested properties (e.g. steps[0].uischema.elements[0].products) is supported.
178
+ *
179
+ */
180
+ export interface PatchUpdateJourneyRequest {
181
+ [name: string]: any;
222
182
  /**
223
- * The sort order. Follows Lucene syntax.
224
- *
225
183
  * example:
226
- * lastModifiedAt:desc
184
+ * 509cdffe-424f-457a-95c2-9708c304ce77
227
185
  */
228
- sort?: string;
186
+ journeyId: string; // uuid
229
187
  }
230
188
  export interface SearchJourneysQueryRequest {
231
189
  /**
@@ -346,51 +304,6 @@ declare namespace Components {
346
304
  journey_version?: "Flex" | "Widget";
347
305
  }[];
348
306
  }
349
- export interface Widget {
350
- [name: string]: any;
351
- widgetId?: string;
352
- organizationId: string;
353
- name?: string;
354
- initialStepId?: string;
355
- styling?: {
356
- [name: string]: any;
357
- theming_options?: {
358
- [name: string]: any;
359
- };
360
- };
361
- shop?: any;
362
- steps?: any[];
363
- results?: any;
364
- builder?: {
365
- [name: string]: any;
366
- name?: string;
367
- description?: string;
368
- category?: string;
369
- bundle_category?: string;
370
- brand_id: string | number;
371
- style_id?: string;
372
- entity_id?: string | null;
373
- template_id?: string;
374
- steps?: {
375
- [name: string]: {
376
- [name: string]: any;
377
- };
378
- };
379
- created_by?: string;
380
- created_at?: string; // date-time
381
- last_modified_by?: string;
382
- last_modified_at?: string; // date-time
383
- active?: boolean;
384
- selected_products?: string[];
385
- selected_addons?: string[];
386
- enable_automation_email?: boolean;
387
- email_template_id?: string | number;
388
- targets?: string[];
389
- useBaseElementsLibrary?: boolean;
390
- };
391
- last_modified_at?: string;
392
- created_at?: string;
393
- }
394
307
  }
395
308
  }
396
309
  declare namespace Paths {
@@ -400,37 +313,6 @@ declare namespace Paths {
400
313
  export type $201 = Components.Schemas.JourneyResponse;
401
314
  }
402
315
  }
403
- namespace CreateJourneyStepTemplate {
404
- export type RequestBody = Components.Schemas.JourneyStepTemplateCreationRequest;
405
- }
406
- namespace CreateJourneyTemplate {
407
- export type RequestBody = Components.Schemas.JourneyTemplateCreationRequest;
408
- }
409
- namespace CreateWidget {
410
- export type RequestBody = Components.Schemas.Widget;
411
- }
412
- namespace FilesPersist {
413
- export type RequestBody = Components.Schemas.PersistFilesRequest;
414
- }
415
- namespace GetCraftsmenJourneys {
416
- export type RequestBody = Components.Schemas.CommissioningJourneyQueryRequest;
417
- }
418
- namespace GetEmailTemplates {
419
- namespace Parameters {
420
- /**
421
- * example:
422
- * 123
423
- */
424
- export type Id = string;
425
- }
426
- export interface PathParameters {
427
- id: /**
428
- * example:
429
- * 123
430
- */
431
- Parameters.Id;
432
- }
433
- }
434
316
  namespace GetJourney {
435
317
  namespace Parameters {
436
318
  /**
@@ -456,13 +338,19 @@ declare namespace Paths {
456
338
  export type $200 = Components.Schemas.JourneyResponse;
457
339
  }
458
340
  }
459
- namespace GetJourneyStepTemplateById {
341
+ namespace GetJourneyProducts {
460
342
  namespace Parameters {
343
+ export type City = string;
461
344
  /**
462
345
  * example:
463
346
  * 509cdffe-424f-457a-95c2-9708c304ce77
464
347
  */
465
348
  export type Id = string; // uuid
349
+ export type OrgId = string;
350
+ export type PostalCode = string;
351
+ export type Source = string;
352
+ export type Street = string;
353
+ export type StreetNumber = string;
466
354
  }
467
355
  export interface PathParameters {
468
356
  id: /**
@@ -471,21 +359,16 @@ declare namespace Paths {
471
359
  */
472
360
  Parameters.Id /* uuid */;
473
361
  }
474
- }
475
- namespace GetJourneyTemplateById {
476
- namespace Parameters {
477
- /**
478
- * example:
479
- * 509cdffe-424f-457a-95c2-9708c304ce77
480
- */
481
- export type Id = string; // uuid
362
+ export interface QueryParameters {
363
+ source?: Parameters.Source;
364
+ orgId?: Parameters.OrgId;
365
+ postal_code?: Parameters.PostalCode;
366
+ city?: Parameters.City;
367
+ street?: Parameters.Street;
368
+ street_number?: Parameters.StreetNumber;
482
369
  }
483
- export interface PathParameters {
484
- id: /**
485
- * example:
486
- * 509cdffe-424f-457a-95c2-9708c304ce77
487
- */
488
- Parameters.Id /* uuid */;
370
+ namespace Responses {
371
+ export type $200 = Components.Schemas.JourneyProductsResponse;
489
372
  }
490
373
  }
491
374
  namespace GetJourneysByOrgId {
@@ -507,28 +390,14 @@ declare namespace Paths {
507
390
  export type $200 = Components.Schemas.GetJourneysResponse;
508
391
  }
509
392
  }
510
- namespace GetWidget {
511
- namespace Parameters {
512
- /**
513
- * example:
514
- * 509cdffe-424f-457a-95c2-9708c304ce77
515
- */
516
- export type Id = string; // uuid
517
- export type OrgId = string;
518
- export type Source = string;
519
- export type Version = number;
520
- }
521
- export interface PathParameters {
522
- id: /**
523
- * example:
524
- * 509cdffe-424f-457a-95c2-9708c304ce77
525
- */
526
- Parameters.Id /* uuid */;
527
- }
528
- export interface QueryParameters {
529
- version?: Parameters.Version;
530
- source?: Parameters.Source;
531
- orgId?: Parameters.OrgId;
393
+ namespace PatchUpdateJourney {
394
+ export type RequestBody = /**
395
+ * Patch request to update a journey (journey id is required) Support for nested properties (e.g. steps[0].uischema.elements[0].products) is supported.
396
+ *
397
+ */
398
+ Components.Schemas.PatchUpdateJourneyRequest;
399
+ namespace Responses {
400
+ export type $200 = Components.Schemas.JourneyResponse;
532
401
  }
533
402
  }
534
403
  namespace RemoveJourney {
@@ -547,102 +416,18 @@ declare namespace Paths {
547
416
  Parameters.Id /* uuid */;
548
417
  }
549
418
  }
550
- namespace RemoveJourneyStepTemplate {
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 RemoveJourneyTemplate {
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 RemoveWidget {
583
- namespace Parameters {
584
- /**
585
- * example:
586
- * 509cdffe-424f-457a-95c2-9708c304ce77
587
- */
588
- export type Id = string; // uuid
589
- }
590
- export interface PathParameters {
591
- id: /**
592
- * example:
593
- * 509cdffe-424f-457a-95c2-9708c304ce77
594
- */
595
- Parameters.Id /* uuid */;
596
- }
597
- }
598
- namespace RemoveWidgets {
599
- namespace Parameters {
600
- export type WidgetId = string[];
601
- }
602
- export interface QueryParameters {
603
- widgetId: Parameters.WidgetId;
604
- }
605
- }
606
- namespace SearchJourneyTemplates {
607
- export type RequestBody = Components.Schemas.SearchJourneyTemplatesQueryRequest;
608
- }
609
419
  namespace SearchJourneys {
610
420
  export type RequestBody = Components.Schemas.SearchJourneysQueryRequest;
611
421
  namespace Responses {
612
422
  export type $200 = Components.Schemas.SearchJourneysResponse;
613
423
  }
614
424
  }
615
- namespace SearchWidgetByOrganizationId {
616
- namespace Parameters {
617
- /**
618
- * example:
619
- * 123
620
- */
621
- export type Id = string;
622
- }
623
- export interface PathParameters {
624
- id: /**
625
- * example:
626
- * 123
627
- */
628
- Parameters.Id;
629
- }
630
- }
631
425
  namespace UpdateJourney {
632
426
  export type RequestBody = Components.Schemas.JourneyCreationRequest;
633
427
  namespace Responses {
634
428
  export type $200 = Components.Schemas.JourneyResponse;
635
429
  }
636
430
  }
637
- namespace UpdateJourneyStepTemplate {
638
- export type RequestBody = Components.Schemas.JourneyStepTemplateCreationRequest;
639
- }
640
- namespace UpdateJourneyTemplate {
641
- export type RequestBody = Components.Schemas.JourneyTemplateUpdateRequest;
642
- }
643
- namespace UpdateWidget {
644
- export type RequestBody = Components.Schemas.Widget;
645
- }
646
431
  }
647
432
 
648
433
  export interface OperationMethods {
@@ -676,6 +461,16 @@ export interface OperationMethods {
676
461
  data?: any,
677
462
  config?: AxiosRequestConfig
678
463
  ): OperationResponse<any>
464
+ /**
465
+ * getJourneyProducts - getJourneyProducts
466
+ *
467
+ * Get products available in the journey by id
468
+ */
469
+ 'getJourneyProducts'(
470
+ parameters?: Parameters<Paths.GetJourneyProducts.PathParameters & Paths.GetJourneyProducts.QueryParameters> | null,
471
+ data?: any,
472
+ config?: AxiosRequestConfig
473
+ ): OperationResponse<Paths.GetJourneyProducts.Responses.$200>
679
474
  /**
680
475
  * updateJourney - updateJourney
681
476
  *
@@ -697,195 +492,15 @@ export interface OperationMethods {
697
492
  config?: AxiosRequestConfig
698
493
  ): OperationResponse<Paths.CreateJourney.Responses.$201>
699
494
  /**
700
- * getJourneysTemplates - getJourneysTemplates
701
- *
702
- * Get All Journey Templates
703
- */
704
- 'getJourneysTemplates'(
705
- parameters?: Parameters<UnknownParamsObject> | null,
706
- data?: any,
707
- config?: AxiosRequestConfig
708
- ): OperationResponse<any>
709
- /**
710
- * createJourneyTemplate - createJourneyTemplate
711
- *
712
- * Get a new Journey Template
713
- */
714
- 'createJourneyTemplate'(
715
- parameters?: Parameters<UnknownParamsObject> | null,
716
- data?: Paths.CreateJourneyTemplate.RequestBody,
717
- config?: AxiosRequestConfig
718
- ): OperationResponse<any>
719
- /**
720
- * updateJourneyTemplate - updateJourneyTemplate
495
+ * patchUpdateJourney - patchUpdateJourney
721
496
  *
722
- * Update a Journey Template
497
+ * Update a Journey (partially / patch). Support for nested properties updates (e.g. "property[0].name").
723
498
  */
724
- 'updateJourneyTemplate'(
499
+ 'patchUpdateJourney'(
725
500
  parameters?: Parameters<UnknownParamsObject> | null,
726
- data?: Paths.UpdateJourneyTemplate.RequestBody,
727
- config?: AxiosRequestConfig
728
- ): OperationResponse<any>
729
- /**
730
- * getJourneyTemplateById - getJourneyTemplateById
731
- *
732
- * Get Journey Template by ID
733
- */
734
- 'getJourneyTemplateById'(
735
- parameters?: Parameters<Paths.GetJourneyTemplateById.PathParameters> | null,
736
- data?: any,
501
+ data?: Paths.PatchUpdateJourney.RequestBody,
737
502
  config?: AxiosRequestConfig
738
- ): OperationResponse<any>
739
- /**
740
- * removeJourneyTemplate - removeJourneyTemplate
741
- *
742
- * Remove Journey Template by id
743
- */
744
- 'removeJourneyTemplate'(
745
- parameters?: Parameters<Paths.RemoveJourneyTemplate.PathParameters> | null,
746
- data?: any,
747
- config?: AxiosRequestConfig
748
- ): OperationResponse<any>
749
- /**
750
- * searchJourneyTemplates - searchJourneyTemplates
751
- *
752
- * Search Journey Templates
753
- */
754
- 'searchJourneyTemplates'(
755
- parameters?: Parameters<UnknownParamsObject> | null,
756
- data?: Paths.SearchJourneyTemplates.RequestBody,
757
- config?: AxiosRequestConfig
758
- ): OperationResponse<any>
759
- /**
760
- * getJourneyStepTemplateById - getJourneyStepTemplateById
761
- *
762
- * Get Journey Step Template by ID
763
- */
764
- 'getJourneyStepTemplateById'(
765
- parameters?: Parameters<Paths.GetJourneyStepTemplateById.PathParameters> | null,
766
- data?: any,
767
- config?: AxiosRequestConfig
768
- ): OperationResponse<any>
769
- /**
770
- * removeJourneyStepTemplate - removeJourneyStepTemplate
771
- *
772
- * Delete Journey Step Template
773
- */
774
- 'removeJourneyStepTemplate'(
775
- parameters?: Parameters<Paths.RemoveJourneyStepTemplate.PathParameters> | null,
776
- data?: any,
777
- config?: AxiosRequestConfig
778
- ): OperationResponse<any>
779
- /**
780
- * getJourneysStepTemplates - getJourneysStepTemplates
781
- *
782
- * Get All Journey Step Templates
783
- */
784
- 'getJourneysStepTemplates'(
785
- parameters?: Parameters<UnknownParamsObject> | null,
786
- data?: any,
787
- config?: AxiosRequestConfig
788
- ): OperationResponse<any>
789
- /**
790
- * createJourneyStepTemplate - createJourneyStepTemplate
791
- *
792
- * Create a new journey step template
793
- */
794
- 'createJourneyStepTemplate'(
795
- parameters?: Parameters<UnknownParamsObject> | null,
796
- data?: Paths.CreateJourneyStepTemplate.RequestBody,
797
- config?: AxiosRequestConfig
798
- ): OperationResponse<any>
799
- /**
800
- * updateJourneyStepTemplate - updateJourneyStepTemplate
801
- *
802
- * Update a journey step template
803
- */
804
- 'updateJourneyStepTemplate'(
805
- parameters?: Parameters<UnknownParamsObject> | null,
806
- data?: Paths.UpdateJourneyStepTemplate.RequestBody,
807
- config?: AxiosRequestConfig
808
- ): OperationResponse<any>
809
- /**
810
- * getWidget - getWidget
811
- *
812
- * Get Widget by ID
813
- */
814
- 'getWidget'(
815
- parameters?: Parameters<Paths.GetWidget.PathParameters & Paths.GetWidget.QueryParameters> | null,
816
- data?: any,
817
- config?: AxiosRequestConfig
818
- ): OperationResponse<any>
819
- /**
820
- * removeWidget - removeWidget
821
- *
822
- * Remove widget by id
823
- */
824
- 'removeWidget'(
825
- parameters?: Parameters<Paths.RemoveWidget.PathParameters> | null,
826
- data?: any,
827
- config?: AxiosRequestConfig
828
- ): OperationResponse<any>
829
- /**
830
- * getCraftsmenJourneys - getCraftsmenJourneys
831
- *
832
- * Get craftsmen Journeys
833
- */
834
- 'getCraftsmenJourneys'(
835
- parameters?: Parameters<UnknownParamsObject> | null,
836
- data?: Paths.GetCraftsmenJourneys.RequestBody,
837
- config?: AxiosRequestConfig
838
- ): OperationResponse<any>
839
- /**
840
- * getEmailTemplates - getEmailTemplates
841
- *
842
- * Get email templates for organization
843
- */
844
- 'getEmailTemplates'(
845
- parameters?: Parameters<Paths.GetEmailTemplates.PathParameters> | null,
846
- data?: any,
847
- config?: AxiosRequestConfig
848
- ): OperationResponse<any>
849
- /**
850
- * searchWidgetByOrganizationId - searchWidgetByOrganizationId
851
- *
852
- * Search widgets by organization ID
853
- */
854
- 'searchWidgetByOrganizationId'(
855
- parameters?: Parameters<Paths.SearchWidgetByOrganizationId.PathParameters> | null,
856
- data?: any,
857
- config?: AxiosRequestConfig
858
- ): OperationResponse<any>
859
- /**
860
- * updateWidget - updateWidget
861
- *
862
- * Update a widget
863
- */
864
- 'updateWidget'(
865
- parameters?: Parameters<UnknownParamsObject> | null,
866
- data?: Paths.UpdateWidget.RequestBody,
867
- config?: AxiosRequestConfig
868
- ): OperationResponse<any>
869
- /**
870
- * createWidget - createWidget
871
- *
872
- * Create new Widget
873
- */
874
- 'createWidget'(
875
- parameters?: Parameters<UnknownParamsObject> | null,
876
- data?: Paths.CreateWidget.RequestBody,
877
- config?: AxiosRequestConfig
878
- ): OperationResponse<any>
879
- /**
880
- * removeWidgets - removeWidgets
881
- *
882
- * Remove widgets
883
- */
884
- 'removeWidgets'(
885
- parameters?: Parameters<Paths.RemoveWidgets.QueryParameters> | null,
886
- data?: any,
887
- config?: AxiosRequestConfig
888
- ): OperationResponse<any>
503
+ ): OperationResponse<Paths.PatchUpdateJourney.Responses.$200>
889
504
  /**
890
505
  * searchJourneys - searchJourneys
891
506
  *
@@ -896,17 +511,6 @@ export interface OperationMethods {
896
511
  data?: Paths.SearchJourneys.RequestBody,
897
512
  config?: AxiosRequestConfig
898
513
  ): OperationResponse<Paths.SearchJourneys.Responses.$200>
899
- /**
900
- * filesPersist - filesPersist
901
- *
902
- * This API is deprecated and will be removed. Please pass files directly via [Submission API](https://docs.epilot.io/api/submission/#tag/Submissions)
903
- *
904
- */
905
- 'filesPersist'(
906
- parameters?: Parameters<UnknownParamsObject> | null,
907
- data?: Paths.FilesPersist.RequestBody,
908
- config?: AxiosRequestConfig
909
- ): OperationResponse<any>
910
514
  }
911
515
 
912
516
  export interface PathsDictionary {
@@ -944,6 +548,18 @@ export interface PathsDictionary {
944
548
  config?: AxiosRequestConfig
945
549
  ): OperationResponse<any>
946
550
  }
551
+ ['/v1/journey/products/{id}']: {
552
+ /**
553
+ * getJourneyProducts - getJourneyProducts
554
+ *
555
+ * Get products available in the journey by id
556
+ */
557
+ 'get'(
558
+ parameters?: Parameters<Paths.GetJourneyProducts.PathParameters & Paths.GetJourneyProducts.QueryParameters> | null,
559
+ data?: any,
560
+ config?: AxiosRequestConfig
561
+ ): OperationResponse<Paths.GetJourneyProducts.Responses.$200>
562
+ }
947
563
  ['/v1/journey/configuration']: {
948
564
  /**
949
565
  * createJourney - createJourney
@@ -965,218 +581,16 @@ export interface PathsDictionary {
965
581
  data?: Paths.UpdateJourney.RequestBody,
966
582
  config?: AxiosRequestConfig
967
583
  ): OperationResponse<Paths.UpdateJourney.Responses.$200>
968
- }
969
- ['/v1/journey/templates']: {
970
- /**
971
- * updateJourneyTemplate - updateJourneyTemplate
972
- *
973
- * Update a Journey Template
974
- */
975
- 'patch'(
976
- parameters?: Parameters<UnknownParamsObject> | null,
977
- data?: Paths.UpdateJourneyTemplate.RequestBody,
978
- config?: AxiosRequestConfig
979
- ): OperationResponse<any>
980
584
  /**
981
- * getJourneysTemplates - getJourneysTemplates
585
+ * patchUpdateJourney - patchUpdateJourney
982
586
  *
983
- * Get All Journey Templates
984
- */
985
- 'get'(
986
- parameters?: Parameters<UnknownParamsObject> | null,
987
- data?: any,
988
- config?: AxiosRequestConfig
989
- ): OperationResponse<any>
990
- /**
991
- * createJourneyTemplate - createJourneyTemplate
992
- *
993
- * Get a new Journey Template
994
- */
995
- 'post'(
996
- parameters?: Parameters<UnknownParamsObject> | null,
997
- data?: Paths.CreateJourneyTemplate.RequestBody,
998
- config?: AxiosRequestConfig
999
- ): OperationResponse<any>
1000
- }
1001
- ['/v1/journey/templates/{id}']: {
1002
- /**
1003
- * removeJourneyTemplate - removeJourneyTemplate
1004
- *
1005
- * Remove Journey Template by id
1006
- */
1007
- 'delete'(
1008
- parameters?: Parameters<Paths.RemoveJourneyTemplate.PathParameters> | null,
1009
- data?: any,
1010
- config?: AxiosRequestConfig
1011
- ): OperationResponse<any>
1012
- /**
1013
- * getJourneyTemplateById - getJourneyTemplateById
1014
- *
1015
- * Get Journey Template by ID
1016
- */
1017
- 'get'(
1018
- parameters?: Parameters<Paths.GetJourneyTemplateById.PathParameters> | null,
1019
- data?: any,
1020
- config?: AxiosRequestConfig
1021
- ): OperationResponse<any>
1022
- }
1023
- ['/v1/journey/templates/search']: {
1024
- /**
1025
- * searchJourneyTemplates - searchJourneyTemplates
1026
- *
1027
- * Search Journey Templates
1028
- */
1029
- 'post'(
1030
- parameters?: Parameters<UnknownParamsObject> | null,
1031
- data?: Paths.SearchJourneyTemplates.RequestBody,
1032
- config?: AxiosRequestConfig
1033
- ): OperationResponse<any>
1034
- }
1035
- ['/v1/journey/step/templates/{id}']: {
1036
- /**
1037
- * removeJourneyStepTemplate - removeJourneyStepTemplate
1038
- *
1039
- * Delete Journey Step Template
1040
- */
1041
- 'delete'(
1042
- parameters?: Parameters<Paths.RemoveJourneyStepTemplate.PathParameters> | null,
1043
- data?: any,
1044
- config?: AxiosRequestConfig
1045
- ): OperationResponse<any>
1046
- /**
1047
- * getJourneyStepTemplateById - getJourneyStepTemplateById
1048
- *
1049
- * Get Journey Step Template by ID
1050
- */
1051
- 'get'(
1052
- parameters?: Parameters<Paths.GetJourneyStepTemplateById.PathParameters> | null,
1053
- data?: any,
1054
- config?: AxiosRequestConfig
1055
- ): OperationResponse<any>
1056
- }
1057
- ['/v1/journey/step/templates']: {
1058
- /**
1059
- * getJourneysStepTemplates - getJourneysStepTemplates
1060
- *
1061
- * Get All Journey Step Templates
1062
- */
1063
- 'get'(
1064
- parameters?: Parameters<UnknownParamsObject> | null,
1065
- data?: any,
1066
- config?: AxiosRequestConfig
1067
- ): OperationResponse<any>
1068
- /**
1069
- * createJourneyStepTemplate - createJourneyStepTemplate
1070
- *
1071
- * Create a new journey step template
1072
- */
1073
- 'post'(
1074
- parameters?: Parameters<UnknownParamsObject> | null,
1075
- data?: Paths.CreateJourneyStepTemplate.RequestBody,
1076
- config?: AxiosRequestConfig
1077
- ): OperationResponse<any>
1078
- /**
1079
- * updateJourneyStepTemplate - updateJourneyStepTemplate
1080
- *
1081
- * Update a journey step template
587
+ * Update a Journey (partially / patch). Support for nested properties updates (e.g. "property[0].name").
1082
588
  */
1083
589
  'patch'(
1084
590
  parameters?: Parameters<UnknownParamsObject> | null,
1085
- data?: Paths.UpdateJourneyStepTemplate.RequestBody,
591
+ data?: Paths.PatchUpdateJourney.RequestBody,
1086
592
  config?: AxiosRequestConfig
1087
- ): OperationResponse<any>
1088
- }
1089
- ['/v1/widget/configuration/{id}']: {
1090
- /**
1091
- * getWidget - getWidget
1092
- *
1093
- * Get Widget by ID
1094
- */
1095
- 'get'(
1096
- parameters?: Parameters<Paths.GetWidget.PathParameters & Paths.GetWidget.QueryParameters> | null,
1097
- data?: any,
1098
- config?: AxiosRequestConfig
1099
- ): OperationResponse<any>
1100
- /**
1101
- * removeWidget - removeWidget
1102
- *
1103
- * Remove widget by id
1104
- */
1105
- 'delete'(
1106
- parameters?: Parameters<Paths.RemoveWidget.PathParameters> | null,
1107
- data?: any,
1108
- config?: AxiosRequestConfig
1109
- ): OperationResponse<any>
1110
- }
1111
- ['/v1/widget/craftsmen']: {
1112
- /**
1113
- * getCraftsmenJourneys - getCraftsmenJourneys
1114
- *
1115
- * Get craftsmen Journeys
1116
- */
1117
- 'post'(
1118
- parameters?: Parameters<UnknownParamsObject> | null,
1119
- data?: Paths.GetCraftsmenJourneys.RequestBody,
1120
- config?: AxiosRequestConfig
1121
- ): OperationResponse<any>
1122
- }
1123
- ['/v1/widget/email-templates/{id}']: {
1124
- /**
1125
- * getEmailTemplates - getEmailTemplates
1126
- *
1127
- * Get email templates for organization
1128
- */
1129
- 'get'(
1130
- parameters?: Parameters<Paths.GetEmailTemplates.PathParameters> | null,
1131
- data?: any,
1132
- config?: AxiosRequestConfig
1133
- ): OperationResponse<any>
1134
- }
1135
- ['/v1/widget/organization/{id}']: {
1136
- /**
1137
- * searchWidgetByOrganizationId - searchWidgetByOrganizationId
1138
- *
1139
- * Search widgets by organization ID
1140
- */
1141
- 'get'(
1142
- parameters?: Parameters<Paths.SearchWidgetByOrganizationId.PathParameters> | null,
1143
- data?: any,
1144
- config?: AxiosRequestConfig
1145
- ): OperationResponse<any>
1146
- }
1147
- ['/v1/widget/configuration']: {
1148
- /**
1149
- * createWidget - createWidget
1150
- *
1151
- * Create new Widget
1152
- */
1153
- 'post'(
1154
- parameters?: Parameters<UnknownParamsObject> | null,
1155
- data?: Paths.CreateWidget.RequestBody,
1156
- config?: AxiosRequestConfig
1157
- ): OperationResponse<any>
1158
- /**
1159
- * updateWidget - updateWidget
1160
- *
1161
- * Update a widget
1162
- */
1163
- 'put'(
1164
- parameters?: Parameters<UnknownParamsObject> | null,
1165
- data?: Paths.UpdateWidget.RequestBody,
1166
- config?: AxiosRequestConfig
1167
- ): OperationResponse<any>
1168
- }
1169
- ['/v1/widget/configuration/delete']: {
1170
- /**
1171
- * removeWidgets - removeWidgets
1172
- *
1173
- * Remove widgets
1174
- */
1175
- 'delete'(
1176
- parameters?: Parameters<Paths.RemoveWidgets.QueryParameters> | null,
1177
- data?: any,
1178
- config?: AxiosRequestConfig
1179
- ): OperationResponse<any>
593
+ ): OperationResponse<Paths.PatchUpdateJourney.Responses.$200>
1180
594
  }
1181
595
  ['/v1/journey/configuration/search']: {
1182
596
  /**
@@ -1190,19 +604,6 @@ export interface PathsDictionary {
1190
604
  config?: AxiosRequestConfig
1191
605
  ): OperationResponse<Paths.SearchJourneys.Responses.$200>
1192
606
  }
1193
- ['/v1/journey/files/persist']: {
1194
- /**
1195
- * filesPersist - filesPersist
1196
- *
1197
- * This API is deprecated and will be removed. Please pass files directly via [Submission API](https://docs.epilot.io/api/submission/#tag/Submissions)
1198
- *
1199
- */
1200
- 'post'(
1201
- parameters?: Parameters<UnknownParamsObject> | null,
1202
- data?: Paths.FilesPersist.RequestBody,
1203
- config?: AxiosRequestConfig
1204
- ): OperationResponse<any>
1205
- }
1206
607
  }
1207
608
 
1208
609
  export type Client = OpenAPIClient<OperationMethods, PathsDictionary>