@epilot/pricing-client 1.13.0 → 1.13.3

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
@@ -11,6 +11,13 @@ declare namespace Components {
11
11
  namespace Schemas {
12
12
  export interface Address {
13
13
  [name: string]: any;
14
+ /**
15
+ * example:
16
+ * [
17
+ * "billing"
18
+ * ]
19
+ */
20
+ _tags?: string[];
14
21
  /**
15
22
  * The first line of the address. Typically the street address or PO Box number.
16
23
  */
@@ -35,8 +42,122 @@ declare namespace Components {
35
42
  * An additional description for the address
36
43
  */
37
44
  additional_info?: string;
45
+ /**
46
+ * the company name, usually used as extra delivery instructions
47
+ */
48
+ company_name?: string;
49
+ /**
50
+ * the first name of the recipient, usually used as extra delivery instructions
51
+ */
52
+ first_name?: string;
53
+ /**
54
+ * the last name of the recipient, usually used as extra delivery instructions
55
+ */
56
+ last_name?: string;
57
+ /**
58
+ * the salutation of the recipient, usually used as extra delivery instructions
59
+ */
60
+ salutation?: string;
61
+ /**
62
+ * the title of the recipient, usually used as extra delivery instructions
63
+ */
64
+ title?: string;
65
+ }
66
+ /**
67
+ * Availability check request payload
68
+ */
69
+ export interface AvailabilityCheckParams {
70
+ /**
71
+ * Products to check availability
72
+ */
73
+ products: string[];
74
+ filters: /* Availability filters dimensions */ AvailabilityFilters;
75
+ }
76
+ export interface AvailabilityDate {
77
+ /**
78
+ * The availability interval start date
79
+ * example:
80
+ * 2017-07-21
81
+ */
82
+ available_start_date?: string; // date
83
+ /**
84
+ * The availability interval end date
85
+ * example:
86
+ * 2017-07-21
87
+ */
88
+ available_end_date?: string; // date
89
+ }
90
+ /**
91
+ * Availability filters dimensions
92
+ */
93
+ export interface AvailabilityFilters {
94
+ location: AvailabilityLocation;
95
+ /**
96
+ * A value to be matched against the availability window (start & end date)
97
+ * example:
98
+ * 2017-07-21
99
+ */
100
+ available_date?: string; // date
101
+ }
102
+ export interface AvailabilityLocation {
103
+ /**
104
+ * The first line of the address. Typically the street address or PO Box number.
105
+ */
106
+ street?: string;
107
+ /**
108
+ * The second line of the address. Typically the number of the apartment, suite, or unit.
109
+ */
110
+ street_number?: string;
111
+ /**
112
+ * The postal code for the address.
113
+ */
114
+ postal_code?: string;
115
+ /**
116
+ * The name of the city, district, village, or town.
117
+ */
118
+ city?: string;
119
+ /**
120
+ * The name of the country.
121
+ */
122
+ country?: string;
123
+ }
124
+ /**
125
+ * The availability check result payload
126
+ * example:
127
+ * {
128
+ * "available_products": [],
129
+ * "check_results": [
130
+ * {
131
+ * "product_id": "my-product-id-123-1",
132
+ * "matching_hits": 0
133
+ * },
134
+ * {
135
+ * "product_id": "my-product-id-123-2",
136
+ * "matching_hits": 0
137
+ * }
138
+ * ]
139
+ * }
140
+ */
141
+ export interface AvailabilityResult {
142
+ available_products: string[];
143
+ /**
144
+ * The check result details
145
+ */
146
+ check_results?: {
147
+ product_id: string;
148
+ /**
149
+ * The number of rules matched
150
+ */
151
+ matching_hits?: number;
152
+ /**
153
+ * A set of matching errors when checking availability
154
+ */
155
+ matching_error?: {
156
+ [name: string]: any;
157
+ };
158
+ }[];
38
159
  }
39
- export type BillingPeriod = "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly";
160
+ export type BillingPeriod = "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly" | "one_time";
40
161
  /**
41
162
  * Supports shopping for products and services until ready for checkout.
42
163
  */
@@ -82,6 +203,20 @@ declare namespace Components {
82
203
  customer?: Customer;
83
204
  billing_address?: Address;
84
205
  delivery_address?: Address;
206
+ /**
207
+ * type of source, e.g. journey or manual
208
+ * example:
209
+ * journey
210
+ */
211
+ source_type?: string;
212
+ /**
213
+ * identifier for source e.g. journey ID
214
+ * example:
215
+ * ce99875f-fba9-4fe2-a8f9-afaf52059051
216
+ */
217
+ source_id?: string;
218
+ source?: /* Order Source */ OrderSource;
219
+ additional_addresses?: Address[];
85
220
  payment_method?: /**
86
221
  * A PaymentMethod represent your customer's payment instruments.
87
222
  *
@@ -92,6 +227,14 @@ declare namespace Components {
92
227
  * An array of file IDs, already upload into the File API, that are related with this cart
93
228
  */
94
229
  files?: string[];
230
+ status?: /* The order status */ OrderStatus;
231
+ tags?: string[];
232
+ journey_data?: {
233
+ [name: string]: any;
234
+ };
235
+ consents?: {
236
+ [name: string]: any;
237
+ };
95
238
  }
96
239
  /**
97
240
  * A catalog search payload
@@ -100,14 +243,25 @@ declare namespace Components {
100
243
  * "q": "_id:1233432 OR _id:123432454 OR _id:23445433",
101
244
  * "sort": "description ASC",
102
245
  * "from": 0,
103
- * "size": 200
246
+ * "size": 200,
247
+ * "availability": {
248
+ * "location": {
249
+ * "postal_code": "57008,",
250
+ * "city": "Cologne,",
251
+ * "street": "Media Park,",
252
+ * "street_number": "8a"
253
+ * },
254
+ * "available_date": {
255
+ * "value": "2022-05-01"
256
+ * }
257
+ * }
104
258
  * }
105
259
  */
106
260
  export interface CatalogSearch {
107
261
  /**
108
262
  * The query to perform using lucene query syntax.
109
263
  */
110
- q?: string;
264
+ q: string;
111
265
  /**
112
266
  * The sort expression to sort the results.
113
267
  */
@@ -121,9 +275,10 @@ declare namespace Components {
121
275
  */
122
276
  size?: number;
123
277
  /**
124
- * A list of additional fields to expand on the search results, such as non-indexed fields.
278
+ * When true, enables entity hydration to resolve nested $relation references in-place.
125
279
  */
126
- expand?: string[];
280
+ hydrate?: boolean;
281
+ availability?: /* Availability filters dimensions */ AvailabilityFilters;
127
282
  }
128
283
  /**
129
284
  * The query result payload
@@ -170,6 +325,8 @@ declare namespace Components {
170
325
  * Three-letter ISO currency code, in lowercase. Must be a supported currency.
171
326
  * ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
172
327
  *
328
+ * example:
329
+ * EUR
173
330
  */
174
331
  export type Currency = string;
175
332
  export interface Customer {
@@ -183,12 +340,36 @@ declare namespace Components {
183
340
  email?: string;
184
341
  phone?: string;
185
342
  }
343
+ export interface EntityRelation {
344
+ [name: string]: any;
345
+ entity_id?: string;
346
+ _tags?: string[];
347
+ }
186
348
  export interface Error {
187
349
  /**
188
350
  * Error message
189
351
  */
190
352
  message: string;
191
353
  }
354
+ export interface File {
355
+ [name: string]: any;
356
+ _id: string;
357
+ filename: string;
358
+ mime_type: string;
359
+ versions: {
360
+ [name: string]: any;
361
+ s3ref: {
362
+ bucket: string;
363
+ key: string;
364
+ };
365
+ }[];
366
+ _schema: string;
367
+ _org: string;
368
+ _created_at: string; // date-time
369
+ _updated_at: string; // date-time
370
+ _title?: string;
371
+ $relation?: EntityRelation;
372
+ }
192
373
  /**
193
374
  * A set of key-value pairs.
194
375
  */
@@ -229,8 +410,38 @@ declare namespace Components {
229
410
  _id?: string;
230
411
  _created_at?: string;
231
412
  _updated_at?: string;
413
+ /**
414
+ * type of source, e.g. journey or manual
415
+ * example:
416
+ * journey
417
+ */
418
+ source_type?: string;
419
+ /**
420
+ * identifier for source e.g. journey ID
421
+ * example:
422
+ * ce99875f-fba9-4fe2-a8f9-afaf52059051
423
+ */
424
+ source_id?: string;
425
+ source?: /* Order Source */ OpportunitySource;
232
426
  _tags?: string[];
233
427
  }
428
+ /**
429
+ * Order Source
430
+ */
431
+ export interface OpportunitySource {
432
+ /**
433
+ * Link path for the source
434
+ * example:
435
+ * /app/v2/journey-builder/editor/db7f6940-994b-11ec-a46d-9f1824ff2939
436
+ */
437
+ http?: string;
438
+ /**
439
+ * Title for the source
440
+ * example:
441
+ * Journey: PH Journey
442
+ */
443
+ title?: string;
444
+ }
234
445
  /**
235
446
  * The order entity
236
447
  */
@@ -244,10 +455,20 @@ declare namespace Components {
244
455
  * The cart id that originated or is associated with the order
245
456
  */
246
457
  cart_id?: string;
458
+ status?: /* The order status */ OrderStatus;
247
459
  /**
248
- * The order status
460
+ * type of source, e.g. journey or manual
461
+ * example:
462
+ * journey
249
463
  */
250
- status?: "draft" | "quote" | "open" | "paid" | "shipped" | "delivered" | "complete";
464
+ source_type?: string;
465
+ /**
466
+ * identifier for source e.g. journey ID
467
+ * example:
468
+ * ce99875f-fba9-4fe2-a8f9-afaf52059051
469
+ */
470
+ source_id?: string;
471
+ source?: /* Order Source */ OrderSource;
251
472
  metadata?: /* A set of key-value pairs. */ MetaData;
252
473
  billing_first_name?: string;
253
474
  billing_last_name?: string;
@@ -260,6 +481,8 @@ declare namespace Components {
260
481
  * Three-letter ISO currency code, in lowercase. Must be a supported currency.
261
482
  * ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
262
483
  *
484
+ * example:
485
+ * EUR
263
486
  */
264
487
  Currency;
265
488
  delivery_address?: Address[];
@@ -291,6 +514,45 @@ declare namespace Components {
291
514
  _updated_at?: string;
292
515
  _tags?: string[];
293
516
  }
517
+ /**
518
+ * Order Entity Payload
519
+ */
520
+ export interface OrderPayload {
521
+ status?: /* The order status */ OrderStatus;
522
+ line_items?: /* Tracks a set of product prices, quantities, (discounts) and taxes. */ PriceItems;
523
+ /**
524
+ * type of source, e.g. journey or manual
525
+ * example:
526
+ * journey
527
+ */
528
+ source_type?: string;
529
+ currency?: /**
530
+ * Three-letter ISO currency code, in lowercase. Must be a supported currency.
531
+ * ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
532
+ *
533
+ * example:
534
+ * EUR
535
+ */
536
+ Currency;
537
+ /**
538
+ * The id of an existing contact.
539
+ */
540
+ contact?: string;
541
+ billing_first_name?: string;
542
+ billing_last_name?: string;
543
+ billing_company_name?: string;
544
+ billing_vat?: string;
545
+ billing_email?: string;
546
+ billing_phone?: string;
547
+ billing_address?: Address[];
548
+ delivery_address?: Address[];
549
+ payment_method?: /**
550
+ * A PaymentMethod represent your customer's payment instruments.
551
+ *
552
+ */
553
+ PaymentMethod[];
554
+ _tags?: string[];
555
+ }
294
556
  /**
295
557
  * An order relation reference
296
558
  */
@@ -301,6 +563,27 @@ declare namespace Components {
301
563
  entity_id?: string;
302
564
  _tags?: string[];
303
565
  }
566
+ /**
567
+ * Order Source
568
+ */
569
+ export interface OrderSource {
570
+ /**
571
+ * Link path for the source
572
+ * example:
573
+ * /app/v2/journey-builder/editor/db7f6940-994b-11ec-a46d-9f1824ff2939
574
+ */
575
+ http?: string;
576
+ /**
577
+ * Title for the source
578
+ * example:
579
+ * Journey: PH Journey
580
+ */
581
+ title?: string;
582
+ }
583
+ /**
584
+ * The order status
585
+ */
586
+ export type OrderStatus = "draft" | "quote" | "placed" | "cancelled" | "completed";
304
587
  /**
305
588
  * A PaymentMethod represent your customer's payment instruments.
306
589
  *
@@ -325,7 +608,7 @@ declare namespace Components {
325
608
  active?: boolean;
326
609
  billing_scheme?: "Per Unit";
327
610
  description?: string;
328
- sales_tax?: SalexTax;
611
+ sales_tax?: SalesTax;
329
612
  tax_behavior?: "inclusive" | "exclusive";
330
613
  tiers_mode?: "Standard";
331
614
  type?: "one_time" | "recurring";
@@ -336,6 +619,8 @@ declare namespace Components {
336
619
  * Three-letter ISO currency code, in lowercase. Must be a supported currency.
337
620
  * ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
338
621
  *
622
+ * example:
623
+ * EUR
339
624
  */
340
625
  Currency;
341
626
  billing_duration_amount?: number;
@@ -368,6 +653,10 @@ declare namespace Components {
368
653
  * Total before any (discounts or) taxes are applied.
369
654
  */
370
655
  amount_subtotal?: number;
656
+ /**
657
+ * Net unit amount without taxes.
658
+ */
659
+ unit_amount_net?: number;
371
660
  /**
372
661
  * Total after (discounts and) taxes.
373
662
  */
@@ -376,6 +665,8 @@ declare namespace Components {
376
665
  * Three-letter ISO currency code, in lowercase. Must be a supported currency.
377
666
  * ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
378
667
  *
668
+ * example:
669
+ * EUR
379
670
  */
380
671
  Currency;
381
672
  /**
@@ -435,6 +726,10 @@ declare namespace Components {
435
726
  */
436
727
  recurrences?: (/* An amount associated with a specific recurrence. */ RecurrenceAmountDto)[];
437
728
  _price?: /* The price configuration */ Price;
729
+ /**
730
+ * The product linked to the price item.
731
+ */
732
+ _product?: /* The product configuration */ Product;
438
733
  }
439
734
  /**
440
735
  * Tracks a set of product prices, quantities, (discounts) and taxes.
@@ -469,6 +764,7 @@ declare namespace Components {
469
764
  name?: string;
470
765
  _id?: string;
471
766
  _title?: string;
767
+ _availability_files?: File[];
472
768
  }
473
769
  /**
474
770
  * An amount associated with a specific recurrence.
@@ -520,7 +816,7 @@ declare namespace Components {
520
816
  */
521
817
  amount_tax?: number;
522
818
  }
523
- export type SalexTax = "nontaxable" | "reduced" | "standard";
819
+ export type SalesTax = "nontaxable" | "reduced" | "standard";
524
820
  /**
525
821
  * the tax configuration
526
822
  */
@@ -593,56 +889,60 @@ declare namespace Components {
593
889
  }
594
890
  }
595
891
  declare namespace Paths {
596
- namespace $CheckoutCart {
892
+ namespace $AvailabilityCheck {
597
893
  export interface HeaderParameters {
598
894
  "X-Ivy-Org-ID": Parameters.XIvyOrgID;
599
895
  }
600
896
  namespace Parameters {
601
897
  export type XIvyOrgID = string;
602
898
  }
603
- export type RequestBody = /* The cart checkout request payload */ Components.Schemas.CheckoutCart;
899
+ export type RequestBody = /* Availability check request payload */ Components.Schemas.AvailabilityCheckParams;
604
900
  namespace Responses {
605
- export type $200 = /* The cart checkout result */ Components.Schemas.CheckoutCartResult;
901
+ export type $200 = /**
902
+ * The availability check result payload
903
+ * example:
904
+ * {
905
+ * "available_products": [],
906
+ * "check_results": [
907
+ * {
908
+ * "product_id": "my-product-id-123-1",
909
+ * "matching_hits": 0
910
+ * },
911
+ * {
912
+ * "product_id": "my-product-id-123-2",
913
+ * "matching_hits": 0
914
+ * }
915
+ * ]
916
+ * }
917
+ */
918
+ Components.Schemas.AvailabilityResult;
606
919
  export type $400 = Components.Schemas.Error;
607
920
  }
608
921
  }
609
- namespace $CreateOpportunity {
922
+ namespace $CheckoutCart {
610
923
  export interface HeaderParameters {
611
924
  "X-Ivy-Org-ID": Parameters.XIvyOrgID;
612
925
  }
613
926
  namespace Parameters {
614
927
  export type XIvyOrgID = string;
615
928
  }
616
- export type RequestBody = /* The opportunity entity */ Components.Schemas.Opportunity;
929
+ export type RequestBody = /* The cart checkout request payload */ Components.Schemas.CheckoutCart;
617
930
  namespace Responses {
618
- export type $201 = /* The opportunity entity */ Components.Schemas.Opportunity;
931
+ export type $200 = /* The cart checkout result */ Components.Schemas.CheckoutCartResult;
619
932
  export type $400 = Components.Schemas.Error;
620
933
  }
621
934
  }
622
- namespace $DeleteCart {
623
- namespace Parameters {
624
- export type CartId = string;
625
- }
626
- export interface PathParameters {
627
- "cart-id": Parameters.CartId;
628
- }
629
- namespace Responses {
630
- export type $200 = /* Supports shopping for products and services until ready for checkout. */ Components.Schemas.Cart;
631
- export type $400 = Components.Schemas.Error;
935
+ namespace $CreateOpportunity {
936
+ export interface HeaderParameters {
937
+ "X-Ivy-Org-ID": Parameters.XIvyOrgID;
632
938
  }
633
- }
634
- namespace $GetCart {
635
939
  namespace Parameters {
636
- export type CartId = string;
637
- }
638
- export interface PathParameters {
639
- "cart-id": Parameters.CartId;
940
+ export type XIvyOrgID = string;
640
941
  }
942
+ export type RequestBody = /* The opportunity entity */ Components.Schemas.Opportunity;
641
943
  namespace Responses {
642
- export type $200 = /* Supports shopping for products and services until ready for checkout. */ Components.Schemas.Cart;
944
+ export type $201 = /* The opportunity entity */ Components.Schemas.Opportunity;
643
945
  export type $400 = Components.Schemas.Error;
644
- export interface $404 {
645
- }
646
946
  }
647
947
  }
648
948
  namespace $SearchCatalog {
@@ -659,7 +959,18 @@ declare namespace Paths {
659
959
  * "q": "_id:1233432 OR _id:123432454 OR _id:23445433",
660
960
  * "sort": "description ASC",
661
961
  * "from": 0,
662
- * "size": 200
962
+ * "size": 200,
963
+ * "availability": {
964
+ * "location": {
965
+ * "postal_code": "57008,",
966
+ * "city": "Cologne,",
967
+ * "street": "Media Park,",
968
+ * "street_number": "8a"
969
+ * },
970
+ * "available_date": {
971
+ * "value": "2022-05-01"
972
+ * }
973
+ * }
663
974
  * }
664
975
  */
665
976
  Components.Schemas.CatalogSearch;
@@ -685,25 +996,23 @@ declare namespace Paths {
685
996
  export type $400 = Components.Schemas.Error;
686
997
  }
687
998
  }
688
- namespace $UpsertCart {
689
- export interface HeaderParameters {
690
- "X-Ivy-Org-ID": Parameters.XIvyOrgID;
691
- }
692
- namespace Parameters {
693
- export type XIvyOrgID = string;
694
- }
695
- export type RequestBody = /* A valid cart payload from a client. */ Components.Schemas.CartDto;
999
+ namespace CreateOrder {
1000
+ export type RequestBody = /* Order Entity Payload */ Components.Schemas.OrderPayload;
696
1001
  namespace Responses {
697
- export type $200 = /* Supports shopping for products and services until ready for checkout. */ Components.Schemas.Cart;
698
- export type $201 = /* Supports shopping for products and services until ready for checkout. */ Components.Schemas.Cart;
1002
+ export type $201 = /* The order entity */ Components.Schemas.Order;
699
1003
  export type $400 = Components.Schemas.Error;
700
1004
  }
701
1005
  }
702
- namespace $UpsertOrder {
703
- export type RequestBody = /* The order entity */ Components.Schemas.Order;
1006
+ namespace PutOrder {
1007
+ namespace Parameters {
1008
+ export type Id = string;
1009
+ }
1010
+ export interface PathParameters {
1011
+ id: Parameters.Id;
1012
+ }
1013
+ export type RequestBody = /* Order Entity Payload */ Components.Schemas.OrderPayload;
704
1014
  namespace Responses {
705
1015
  export type $200 = /* The order entity */ Components.Schemas.Order;
706
- export type $201 = /* The order entity */ Components.Schemas.Order;
707
1016
  export type $400 = Components.Schemas.Error;
708
1017
  }
709
1018
  }
@@ -711,15 +1020,25 @@ declare namespace Paths {
711
1020
 
712
1021
  export interface OperationMethods {
713
1022
  /**
714
- * $upsertCart - upsertCart
1023
+ * createOrder - createOrder
715
1024
  *
716
- * Creates a new cart or updates an existing one.
1025
+ * Create an order
717
1026
  */
718
- '$upsertCart'(
719
- parameters?: Parameters<Paths.$UpsertCart.HeaderParameters> | null,
720
- data?: Paths.$UpsertCart.RequestBody,
1027
+ 'createOrder'(
1028
+ parameters?: Parameters<UnknownParamsObject> | null,
1029
+ data?: Paths.CreateOrder.RequestBody,
721
1030
  config?: AxiosRequestConfig
722
- ): OperationResponse<Paths.$UpsertCart.Responses.$200 | Paths.$UpsertCart.Responses.$201>
1031
+ ): OperationResponse<Paths.CreateOrder.Responses.$201>
1032
+ /**
1033
+ * putOrder - putOrder
1034
+ *
1035
+ * Update an existing Order
1036
+ */
1037
+ 'putOrder'(
1038
+ parameters?: Parameters<Paths.PutOrder.PathParameters> | null,
1039
+ data?: Paths.PutOrder.RequestBody,
1040
+ config?: AxiosRequestConfig
1041
+ ): OperationResponse<Paths.PutOrder.Responses.$200>
723
1042
  /**
724
1043
  * $checkoutCart - checkoutCart
725
1044
  *
@@ -741,44 +1060,6 @@ export interface OperationMethods {
741
1060
  data?: Paths.$CheckoutCart.RequestBody,
742
1061
  config?: AxiosRequestConfig
743
1062
  ): OperationResponse<Paths.$CheckoutCart.Responses.$200>
744
- /**
745
- * $getCart - getCart
746
- *
747
- * Retrieves a cart by id.
748
- */
749
- '$getCart'(
750
- parameters?: Parameters<Paths.$GetCart.PathParameters> | null,
751
- data?: any,
752
- config?: AxiosRequestConfig
753
- ): OperationResponse<Paths.$GetCart.Responses.$200>
754
- /**
755
- * $deleteCart - deleteCart
756
- *
757
- * Deletes the Cart specified and returns its content.
758
- */
759
- '$deleteCart'(
760
- parameters?: Parameters<Paths.$DeleteCart.PathParameters> | null,
761
- data?: any,
762
- config?: AxiosRequestConfig
763
- ): OperationResponse<Paths.$DeleteCart.Responses.$200>
764
- /**
765
- * $upsertOrder - upsertOrder
766
- *
767
- * Creates a new order or updates an existing one. During the creation of an order, an unique customer-readable `order_number` will be generated.
768
- * The `order_number` can be used to universally identify an order within epilot platform.
769
- *
770
- * The upsert operation is idempotent, meaning that multiple calls will have effect just once. Calling the upsert multiple times will not duplicate the items on an order.
771
- *
772
- * When the the `cart_id` payload field is specified, the cart items are appended to the existing order items, or replaced in-place if they belong to the same `cart_id`.
773
- *
774
- * On multiple updates with the same `cart_id` the line items linked with that `cart_id` (`order.line_items[]?.metadata.cart_id`) are removed and re-added.
775
- *
776
- */
777
- '$upsertOrder'(
778
- parameters?: Parameters<UnknownParamsObject> | null,
779
- data?: Paths.$UpsertOrder.RequestBody,
780
- config?: AxiosRequestConfig
781
- ): OperationResponse<Paths.$UpsertOrder.Responses.$200 | Paths.$UpsertOrder.Responses.$201>
782
1063
  /**
783
1064
  * $searchCatalog - searchCatalog
784
1065
  *
@@ -789,10 +1070,20 @@ export interface OperationMethods {
789
1070
  data?: Paths.$SearchCatalog.RequestBody,
790
1071
  config?: AxiosRequestConfig
791
1072
  ): OperationResponse<Paths.$SearchCatalog.Responses.$200>
1073
+ /**
1074
+ * $availabilityCheck - availabilityCheck
1075
+ *
1076
+ * The availability check endpoint
1077
+ */
1078
+ '$availabilityCheck'(
1079
+ parameters?: Parameters<Paths.$AvailabilityCheck.HeaderParameters> | null,
1080
+ data?: Paths.$AvailabilityCheck.RequestBody,
1081
+ config?: AxiosRequestConfig
1082
+ ): OperationResponse<Paths.$AvailabilityCheck.Responses.$200>
792
1083
  /**
793
1084
  * $createOpportunity - createOpportunity
794
1085
  *
795
- * Creates a new opportunity. During the creation of an opportunity, an unique customer-readable `opportunity_number` will be generated.
1086
+ * This API is Deprecated. Please use the Entity API or Submission API to create opportunities. Creates a new opportunity. During the creation of an opportunity, an unique customer-readable `opportunity_number` will be generated.
796
1087
  * The `opportunity_number` can be used to universally identify an opportunity within epilot platform.
797
1088
  *
798
1089
  */
@@ -804,17 +1095,29 @@ export interface OperationMethods {
804
1095
  }
805
1096
 
806
1097
  export interface PathsDictionary {
807
- ['/v1/public/cart']: {
1098
+ ['/v1/order']: {
808
1099
  /**
809
- * $upsertCart - upsertCart
1100
+ * createOrder - createOrder
810
1101
  *
811
- * Creates a new cart or updates an existing one.
1102
+ * Create an order
1103
+ */
1104
+ 'post'(
1105
+ parameters?: Parameters<UnknownParamsObject> | null,
1106
+ data?: Paths.CreateOrder.RequestBody,
1107
+ config?: AxiosRequestConfig
1108
+ ): OperationResponse<Paths.CreateOrder.Responses.$201>
1109
+ }
1110
+ ['/v1/order/{id}']: {
1111
+ /**
1112
+ * putOrder - putOrder
1113
+ *
1114
+ * Update an existing Order
812
1115
  */
813
1116
  'put'(
814
- parameters?: Parameters<Paths.$UpsertCart.HeaderParameters> | null,
815
- data?: Paths.$UpsertCart.RequestBody,
1117
+ parameters?: Parameters<Paths.PutOrder.PathParameters> | null,
1118
+ data?: Paths.PutOrder.RequestBody,
816
1119
  config?: AxiosRequestConfig
817
- ): OperationResponse<Paths.$UpsertCart.Responses.$200 | Paths.$UpsertCart.Responses.$201>
1120
+ ): OperationResponse<Paths.PutOrder.Responses.$200>
818
1121
  }
819
1122
  ['/v1/public/cart:checkout']: {
820
1123
  /**
@@ -839,48 +1142,6 @@ export interface PathsDictionary {
839
1142
  config?: AxiosRequestConfig
840
1143
  ): OperationResponse<Paths.$CheckoutCart.Responses.$200>
841
1144
  }
842
- ['/v1/cart/{cart-id}']: {
843
- /**
844
- * $getCart - getCart
845
- *
846
- * Retrieves a cart by id.
847
- */
848
- 'get'(
849
- parameters?: Parameters<Paths.$GetCart.PathParameters> | null,
850
- data?: any,
851
- config?: AxiosRequestConfig
852
- ): OperationResponse<Paths.$GetCart.Responses.$200>
853
- /**
854
- * $deleteCart - deleteCart
855
- *
856
- * Deletes the Cart specified and returns its content.
857
- */
858
- 'delete'(
859
- parameters?: Parameters<Paths.$DeleteCart.PathParameters> | null,
860
- data?: any,
861
- config?: AxiosRequestConfig
862
- ): OperationResponse<Paths.$DeleteCart.Responses.$200>
863
- }
864
- ['/v1/order']: {
865
- /**
866
- * $upsertOrder - upsertOrder
867
- *
868
- * Creates a new order or updates an existing one. During the creation of an order, an unique customer-readable `order_number` will be generated.
869
- * The `order_number` can be used to universally identify an order within epilot platform.
870
- *
871
- * The upsert operation is idempotent, meaning that multiple calls will have effect just once. Calling the upsert multiple times will not duplicate the items on an order.
872
- *
873
- * When the the `cart_id` payload field is specified, the cart items are appended to the existing order items, or replaced in-place if they belong to the same `cart_id`.
874
- *
875
- * On multiple updates with the same `cart_id` the line items linked with that `cart_id` (`order.line_items[]?.metadata.cart_id`) are removed and re-added.
876
- *
877
- */
878
- 'put'(
879
- parameters?: Parameters<UnknownParamsObject> | null,
880
- data?: Paths.$UpsertOrder.RequestBody,
881
- config?: AxiosRequestConfig
882
- ): OperationResponse<Paths.$UpsertOrder.Responses.$200 | Paths.$UpsertOrder.Responses.$201>
883
- }
884
1145
  ['/v1/public/catalog']: {
885
1146
  /**
886
1147
  * $searchCatalog - searchCatalog
@@ -893,11 +1154,23 @@ export interface PathsDictionary {
893
1154
  config?: AxiosRequestConfig
894
1155
  ): OperationResponse<Paths.$SearchCatalog.Responses.$200>
895
1156
  }
1157
+ ['/v1/public/availability:check']: {
1158
+ /**
1159
+ * $availabilityCheck - availabilityCheck
1160
+ *
1161
+ * The availability check endpoint
1162
+ */
1163
+ 'post'(
1164
+ parameters?: Parameters<Paths.$AvailabilityCheck.HeaderParameters> | null,
1165
+ data?: Paths.$AvailabilityCheck.RequestBody,
1166
+ config?: AxiosRequestConfig
1167
+ ): OperationResponse<Paths.$AvailabilityCheck.Responses.$200>
1168
+ }
896
1169
  ['/v1/public/opportunity']: {
897
1170
  /**
898
1171
  * $createOpportunity - createOpportunity
899
1172
  *
900
- * Creates a new opportunity. During the creation of an opportunity, an unique customer-readable `opportunity_number` will be generated.
1173
+ * This API is Deprecated. Please use the Entity API or Submission API to create opportunities. Creates a new opportunity. During the creation of an opportunity, an unique customer-readable `opportunity_number` will be generated.
901
1174
  * The `opportunity_number` can be used to universally identify an opportunity within epilot platform.
902
1175
  *
903
1176
  */