@epilot/journey-client 0.1.4 → 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;
@@ -68,164 +64,49 @@ 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;
80
79
  }
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;
101
- }
102
- export interface JourneyStepTemplateUpdateRequest {
103
- [name: string]: any;
104
- templateId: string;
80
+ export type JourneyProductsResponse = {
81
+ type?: string;
82
+ _schema?: string;
83
+ _title?: string;
105
84
  name?: string;
85
+ _id?: string;
86
+ _org?: string;
87
+ code?: string;
106
88
  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;
122
- name: string;
123
- steps: {
124
- showStepName?: boolean | null;
125
- title?: string | null;
126
- subTitle?: string | null;
127
- showStepSubtitle?: boolean | null;
128
- showStepper?: boolean | null;
129
- showStepperLabels?: boolean | null;
130
- hideNextButton?: boolean | null;
131
- name: string;
132
- stepId?: string;
133
- schema: any;
134
- uischema: any;
135
- }[];
136
- description?: string | null;
137
- rules?: {
138
- type: "inject" | "injectWithKey";
139
- sourceType: "journey" | "step" | "block";
140
- source: string;
141
- target: string;
142
- }[];
143
- logics?: {
144
- autoGeneratedId?: string;
145
- conditions: string[];
146
- actions: string[];
147
- }[];
148
- createdBy?: string;
149
- tags?: string[];
150
- settings?: {
151
- safeModeAutomation?: boolean;
152
- runtimeEntities?: ("ORDER" | "OPPORTUNITY")[];
89
+ feature?: any[];
90
+ product_images?: any[];
91
+ legal_footnote?: string;
92
+ product_downloads?: any[];
93
+ price?: {
94
+ [key: string]: any;
153
95
  };
96
+ }[];
97
+ export interface JourneyResponse {
154
98
  }
155
- 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 {
156
104
  [name: string]: any;
157
- templateId: string;
158
- 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")[];
188
- };
189
- }
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;
222
105
  /**
223
- * The sort order. Follows Lucene syntax.
224
- *
225
106
  * example:
226
- * lastModifiedAt:desc
107
+ * 509cdffe-424f-457a-95c2-9708c304ce77
227
108
  */
228
- sort?: string;
109
+ journeyId: string; // uuid
229
110
  }
230
111
  export interface SearchJourneysQueryRequest {
231
112
  /**
@@ -346,51 +227,6 @@ declare namespace Components {
346
227
  journey_version?: "Flex" | "Widget";
347
228
  }[];
348
229
  }
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
230
  }
395
231
  }
396
232
  declare namespace Paths {
@@ -400,37 +236,6 @@ declare namespace Paths {
400
236
  export type $201 = Components.Schemas.JourneyResponse;
401
237
  }
402
238
  }
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
239
  namespace GetJourney {
435
240
  namespace Parameters {
436
241
  /**
@@ -456,13 +261,19 @@ declare namespace Paths {
456
261
  export type $200 = Components.Schemas.JourneyResponse;
457
262
  }
458
263
  }
459
- namespace GetJourneyStepTemplateById {
264
+ namespace GetJourneyProducts {
460
265
  namespace Parameters {
266
+ export type City = string;
461
267
  /**
462
268
  * example:
463
269
  * 509cdffe-424f-457a-95c2-9708c304ce77
464
270
  */
465
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;
466
277
  }
467
278
  export interface PathParameters {
468
279
  id: /**
@@ -471,21 +282,16 @@ declare namespace Paths {
471
282
  */
472
283
  Parameters.Id /* uuid */;
473
284
  }
474
- }
475
- namespace GetJourneyTemplateById {
476
- namespace Parameters {
477
- /**
478
- * example:
479
- * 509cdffe-424f-457a-95c2-9708c304ce77
480
- */
481
- 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;
482
292
  }
483
- export interface PathParameters {
484
- id: /**
485
- * example:
486
- * 509cdffe-424f-457a-95c2-9708c304ce77
487
- */
488
- Parameters.Id /* uuid */;
293
+ namespace Responses {
294
+ export type $200 = Components.Schemas.JourneyProductsResponse;
489
295
  }
490
296
  }
491
297
  namespace GetJourneysByOrgId {
@@ -507,28 +313,14 @@ declare namespace Paths {
507
313
  export type $200 = Components.Schemas.GetJourneysResponse;
508
314
  }
509
315
  }
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;
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;
532
324
  }
533
325
  }
534
326
  namespace RemoveJourney {
@@ -547,102 +339,18 @@ declare namespace Paths {
547
339
  Parameters.Id /* uuid */;
548
340
  }
549
341
  }
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
342
  namespace SearchJourneys {
610
343
  export type RequestBody = Components.Schemas.SearchJourneysQueryRequest;
611
344
  namespace Responses {
612
345
  export type $200 = Components.Schemas.SearchJourneysResponse;
613
346
  }
614
347
  }
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
348
  namespace UpdateJourney {
632
349
  export type RequestBody = Components.Schemas.JourneyCreationRequest;
633
350
  namespace Responses {
634
351
  export type $200 = Components.Schemas.JourneyResponse;
635
352
  }
636
353
  }
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
354
  }
647
355
 
648
356
  export interface OperationMethods {
@@ -676,6 +384,16 @@ export interface OperationMethods {
676
384
  data?: any,
677
385
  config?: AxiosRequestConfig
678
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>
679
397
  /**
680
398
  * updateJourney - updateJourney
681
399
  *
@@ -697,195 +415,15 @@ export interface OperationMethods {
697
415
  config?: AxiosRequestConfig
698
416
  ): OperationResponse<Paths.CreateJourney.Responses.$201>
699
417
  /**
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
721
- *
722
- * Update a Journey Template
723
- */
724
- 'updateJourneyTemplate'(
725
- 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,
737
- 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
418
+ * patchUpdateJourney - patchUpdateJourney
871
419
  *
872
- * Create new Widget
420
+ * Update a Journey (partially / patch). Support for nested properties updates (e.g. "property[0].name").
873
421
  */
874
- 'createWidget'(
422
+ 'patchUpdateJourney'(
875
423
  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,
424
+ data?: Paths.PatchUpdateJourney.RequestBody,
887
425
  config?: AxiosRequestConfig
888
- ): OperationResponse<any>
426
+ ): OperationResponse<Paths.PatchUpdateJourney.Responses.$200>
889
427
  /**
890
428
  * searchJourneys - searchJourneys
891
429
  *
@@ -896,17 +434,6 @@ export interface OperationMethods {
896
434
  data?: Paths.SearchJourneys.RequestBody,
897
435
  config?: AxiosRequestConfig
898
436
  ): 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
437
  }
911
438
 
912
439
  export interface PathsDictionary {
@@ -944,6 +471,18 @@ export interface PathsDictionary {
944
471
  config?: AxiosRequestConfig
945
472
  ): OperationResponse<any>
946
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
+ }
947
486
  ['/v1/journey/configuration']: {
948
487
  /**
949
488
  * createJourney - createJourney
@@ -965,218 +504,16 @@ export interface PathsDictionary {
965
504
  data?: Paths.UpdateJourney.RequestBody,
966
505
  config?: AxiosRequestConfig
967
506
  ): OperationResponse<Paths.UpdateJourney.Responses.$200>
968
- }
969
- ['/v1/journey/templates']: {
970
507
  /**
971
- * updateJourneyTemplate - updateJourneyTemplate
508
+ * patchUpdateJourney - patchUpdateJourney
972
509
  *
973
- * Update a Journey Template
510
+ * Update a Journey (partially / patch). Support for nested properties updates (e.g. "property[0].name").
974
511
  */
975
512
  'patch'(
976
513
  parameters?: Parameters<UnknownParamsObject> | null,
977
- data?: Paths.UpdateJourneyTemplate.RequestBody,
514
+ data?: Paths.PatchUpdateJourney.RequestBody,
978
515
  config?: AxiosRequestConfig
979
- ): OperationResponse<any>
980
- /**
981
- * getJourneysTemplates - getJourneysTemplates
982
- *
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
1082
- */
1083
- 'patch'(
1084
- parameters?: Parameters<UnknownParamsObject> | null,
1085
- data?: Paths.UpdateJourneyStepTemplate.RequestBody,
1086
- 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>
516
+ ): OperationResponse<Paths.PatchUpdateJourney.Responses.$200>
1180
517
  }
1181
518
  ['/v1/journey/configuration/search']: {
1182
519
  /**
@@ -1190,19 +527,6 @@ export interface PathsDictionary {
1190
527
  config?: AxiosRequestConfig
1191
528
  ): OperationResponse<Paths.SearchJourneys.Responses.$200>
1192
529
  }
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
530
  }
1207
531
 
1208
532
  export type Client = OpenAPIClient<OperationMethods, PathsDictionary>