@epilot/pricing-client 1.13.0 → 1.13.1

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
  */
@@ -36,7 +43,101 @@ declare namespace Components {
36
43
  */
37
44
  additional_info?: string;
38
45
  }
39
- export type BillingPeriod = "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly";
46
+ /**
47
+ * Availability check request payload
48
+ */
49
+ export interface AvailabilityCheckParams {
50
+ /**
51
+ * Products to check availability
52
+ */
53
+ products: string[];
54
+ filters: /* Availability filters dimensions */ AvailabilityFilters;
55
+ }
56
+ export interface AvailabilityDate {
57
+ /**
58
+ * The availability interval start date
59
+ * example:
60
+ * 2017-07-21
61
+ */
62
+ available_start_date?: string; // date
63
+ /**
64
+ * The availability interval end date
65
+ * example:
66
+ * 2017-07-21
67
+ */
68
+ available_end_date?: string; // date
69
+ }
70
+ /**
71
+ * Availability filters dimensions
72
+ */
73
+ export interface AvailabilityFilters {
74
+ location: AvailabilityLocation;
75
+ /**
76
+ * A value to be matched against the availability window (start & end date)
77
+ * example:
78
+ * 2017-07-21
79
+ */
80
+ available_date?: string; // date
81
+ }
82
+ export interface AvailabilityLocation {
83
+ /**
84
+ * The first line of the address. Typically the street address or PO Box number.
85
+ */
86
+ street?: string;
87
+ /**
88
+ * The second line of the address. Typically the number of the apartment, suite, or unit.
89
+ */
90
+ street_number?: string;
91
+ /**
92
+ * The postal code for the address.
93
+ */
94
+ postal_code?: string;
95
+ /**
96
+ * The name of the city, district, village, or town.
97
+ */
98
+ city?: string;
99
+ /**
100
+ * The name of the country.
101
+ */
102
+ country?: string;
103
+ }
104
+ /**
105
+ * The availability check result payload
106
+ * example:
107
+ * {
108
+ * "available_products": [],
109
+ * "check_results": [
110
+ * {
111
+ * "product_id": "my-product-id-123-1",
112
+ * "matching_hits": 0
113
+ * },
114
+ * {
115
+ * "product_id": "my-product-id-123-2",
116
+ * "matching_hits": 0
117
+ * }
118
+ * ]
119
+ * }
120
+ */
121
+ export interface AvailabilityResult {
122
+ available_products: string[];
123
+ /**
124
+ * The check result details
125
+ */
126
+ check_results?: {
127
+ product_id: string;
128
+ /**
129
+ * The number of rules matched
130
+ */
131
+ matching_hits?: number;
132
+ /**
133
+ * A set of matching errors when checking availability
134
+ */
135
+ matching_error?: {
136
+ [name: string]: any;
137
+ };
138
+ }[];
139
+ }
140
+ export type BillingPeriod = "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly" | "one_time";
40
141
  /**
41
142
  * Supports shopping for products and services until ready for checkout.
42
143
  */
@@ -82,6 +183,20 @@ declare namespace Components {
82
183
  customer?: Customer;
83
184
  billing_address?: Address;
84
185
  delivery_address?: Address;
186
+ /**
187
+ * type of source, e.g. journey or manual
188
+ * example:
189
+ * journey
190
+ */
191
+ source_type?: string;
192
+ /**
193
+ * identifier for source e.g. journey ID
194
+ * example:
195
+ * ce99875f-fba9-4fe2-a8f9-afaf52059051
196
+ */
197
+ source_id?: string;
198
+ source?: /* Order Source */ OrderSource;
199
+ additional_addresses?: Address[];
85
200
  payment_method?: /**
86
201
  * A PaymentMethod represent your customer's payment instruments.
87
202
  *
@@ -92,6 +207,14 @@ declare namespace Components {
92
207
  * An array of file IDs, already upload into the File API, that are related with this cart
93
208
  */
94
209
  files?: string[];
210
+ status?: /* The order status */ OrderStatus;
211
+ tags?: string[];
212
+ journey_data?: {
213
+ [name: string]: any;
214
+ };
215
+ consents?: {
216
+ [name: string]: any;
217
+ };
95
218
  }
96
219
  /**
97
220
  * A catalog search payload
@@ -100,14 +223,25 @@ declare namespace Components {
100
223
  * "q": "_id:1233432 OR _id:123432454 OR _id:23445433",
101
224
  * "sort": "description ASC",
102
225
  * "from": 0,
103
- * "size": 200
226
+ * "size": 200,
227
+ * "availability": {
228
+ * "location": {
229
+ * "postal_code": "57008,",
230
+ * "city": "Cologne,",
231
+ * "street": "Media Park,",
232
+ * "street_number": "8a"
233
+ * },
234
+ * "available_date": {
235
+ * "value": "2022-05-01"
236
+ * }
237
+ * }
104
238
  * }
105
239
  */
106
240
  export interface CatalogSearch {
107
241
  /**
108
242
  * The query to perform using lucene query syntax.
109
243
  */
110
- q?: string;
244
+ q: string;
111
245
  /**
112
246
  * The sort expression to sort the results.
113
247
  */
@@ -121,9 +255,10 @@ declare namespace Components {
121
255
  */
122
256
  size?: number;
123
257
  /**
124
- * A list of additional fields to expand on the search results, such as non-indexed fields.
258
+ * When true, enables entity hydration to resolve nested $relation references in-place.
125
259
  */
126
- expand?: string[];
260
+ hydrate?: boolean;
261
+ availability?: /* Availability filters dimensions */ AvailabilityFilters;
127
262
  }
128
263
  /**
129
264
  * The query result payload
@@ -170,6 +305,8 @@ declare namespace Components {
170
305
  * Three-letter ISO currency code, in lowercase. Must be a supported currency.
171
306
  * ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
172
307
  *
308
+ * example:
309
+ * EUR
173
310
  */
174
311
  export type Currency = string;
175
312
  export interface Customer {
@@ -183,12 +320,36 @@ declare namespace Components {
183
320
  email?: string;
184
321
  phone?: string;
185
322
  }
323
+ export interface EntityRelation {
324
+ [name: string]: any;
325
+ entity_id?: string;
326
+ _tags?: string[];
327
+ }
186
328
  export interface Error {
187
329
  /**
188
330
  * Error message
189
331
  */
190
332
  message: string;
191
333
  }
334
+ export interface File {
335
+ [name: string]: any;
336
+ _id: string;
337
+ filename: string;
338
+ mime_type: string;
339
+ versions: {
340
+ [name: string]: any;
341
+ s3ref: {
342
+ bucket: string;
343
+ key: string;
344
+ };
345
+ }[];
346
+ _schema: string;
347
+ _org: string;
348
+ _created_at: string; // date-time
349
+ _updated_at: string; // date-time
350
+ _title?: string;
351
+ $relation?: EntityRelation;
352
+ }
192
353
  /**
193
354
  * A set of key-value pairs.
194
355
  */
@@ -229,8 +390,38 @@ declare namespace Components {
229
390
  _id?: string;
230
391
  _created_at?: string;
231
392
  _updated_at?: string;
393
+ /**
394
+ * type of source, e.g. journey or manual
395
+ * example:
396
+ * journey
397
+ */
398
+ source_type?: string;
399
+ /**
400
+ * identifier for source e.g. journey ID
401
+ * example:
402
+ * ce99875f-fba9-4fe2-a8f9-afaf52059051
403
+ */
404
+ source_id?: string;
405
+ source?: /* Order Source */ OpportunitySource;
232
406
  _tags?: string[];
233
407
  }
408
+ /**
409
+ * Order Source
410
+ */
411
+ export interface OpportunitySource {
412
+ /**
413
+ * Link path for the source
414
+ * example:
415
+ * /app/v2/journey-builder/editor/db7f6940-994b-11ec-a46d-9f1824ff2939
416
+ */
417
+ http?: string;
418
+ /**
419
+ * Title for the source
420
+ * example:
421
+ * Journey: PH Journey
422
+ */
423
+ title?: string;
424
+ }
234
425
  /**
235
426
  * The order entity
236
427
  */
@@ -244,10 +435,20 @@ declare namespace Components {
244
435
  * The cart id that originated or is associated with the order
245
436
  */
246
437
  cart_id?: string;
438
+ status?: /* The order status */ OrderStatus;
247
439
  /**
248
- * The order status
440
+ * type of source, e.g. journey or manual
441
+ * example:
442
+ * journey
249
443
  */
250
- status?: "draft" | "quote" | "open" | "paid" | "shipped" | "delivered" | "complete";
444
+ source_type?: string;
445
+ /**
446
+ * identifier for source e.g. journey ID
447
+ * example:
448
+ * ce99875f-fba9-4fe2-a8f9-afaf52059051
449
+ */
450
+ source_id?: string;
451
+ source?: /* Order Source */ OrderSource;
251
452
  metadata?: /* A set of key-value pairs. */ MetaData;
252
453
  billing_first_name?: string;
253
454
  billing_last_name?: string;
@@ -260,6 +461,8 @@ declare namespace Components {
260
461
  * Three-letter ISO currency code, in lowercase. Must be a supported currency.
261
462
  * ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
262
463
  *
464
+ * example:
465
+ * EUR
263
466
  */
264
467
  Currency;
265
468
  delivery_address?: Address[];
@@ -291,6 +494,45 @@ declare namespace Components {
291
494
  _updated_at?: string;
292
495
  _tags?: string[];
293
496
  }
497
+ /**
498
+ * Order Entity Payload
499
+ */
500
+ export interface OrderPayload {
501
+ status?: /* The order status */ OrderStatus;
502
+ line_items?: /* Tracks a set of product prices, quantities, (discounts) and taxes. */ PriceItems;
503
+ /**
504
+ * type of source, e.g. journey or manual
505
+ * example:
506
+ * journey
507
+ */
508
+ source_type?: string;
509
+ currency?: /**
510
+ * Three-letter ISO currency code, in lowercase. Must be a supported currency.
511
+ * ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
512
+ *
513
+ * example:
514
+ * EUR
515
+ */
516
+ Currency;
517
+ /**
518
+ * The id of an existing contact.
519
+ */
520
+ contact?: string;
521
+ billing_first_name?: string;
522
+ billing_last_name?: string;
523
+ billing_company_name?: string;
524
+ billing_vat?: string;
525
+ billing_email?: string;
526
+ billing_phone?: string;
527
+ billing_address?: Address[];
528
+ delivery_address?: Address[];
529
+ payment_method?: /**
530
+ * A PaymentMethod represent your customer's payment instruments.
531
+ *
532
+ */
533
+ PaymentMethod[];
534
+ _tags?: string[];
535
+ }
294
536
  /**
295
537
  * An order relation reference
296
538
  */
@@ -301,6 +543,27 @@ declare namespace Components {
301
543
  entity_id?: string;
302
544
  _tags?: string[];
303
545
  }
546
+ /**
547
+ * Order Source
548
+ */
549
+ export interface OrderSource {
550
+ /**
551
+ * Link path for the source
552
+ * example:
553
+ * /app/v2/journey-builder/editor/db7f6940-994b-11ec-a46d-9f1824ff2939
554
+ */
555
+ http?: string;
556
+ /**
557
+ * Title for the source
558
+ * example:
559
+ * Journey: PH Journey
560
+ */
561
+ title?: string;
562
+ }
563
+ /**
564
+ * The order status
565
+ */
566
+ export type OrderStatus = "draft" | "quote" | "placed" | "cancelled" | "completed";
304
567
  /**
305
568
  * A PaymentMethod represent your customer's payment instruments.
306
569
  *
@@ -325,7 +588,7 @@ declare namespace Components {
325
588
  active?: boolean;
326
589
  billing_scheme?: "Per Unit";
327
590
  description?: string;
328
- sales_tax?: SalexTax;
591
+ sales_tax?: SalesTax;
329
592
  tax_behavior?: "inclusive" | "exclusive";
330
593
  tiers_mode?: "Standard";
331
594
  type?: "one_time" | "recurring";
@@ -336,6 +599,8 @@ declare namespace Components {
336
599
  * Three-letter ISO currency code, in lowercase. Must be a supported currency.
337
600
  * ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
338
601
  *
602
+ * example:
603
+ * EUR
339
604
  */
340
605
  Currency;
341
606
  billing_duration_amount?: number;
@@ -368,6 +633,10 @@ declare namespace Components {
368
633
  * Total before any (discounts or) taxes are applied.
369
634
  */
370
635
  amount_subtotal?: number;
636
+ /**
637
+ * Net unit amount without taxes.
638
+ */
639
+ unit_amount_net?: number;
371
640
  /**
372
641
  * Total after (discounts and) taxes.
373
642
  */
@@ -376,6 +645,8 @@ declare namespace Components {
376
645
  * Three-letter ISO currency code, in lowercase. Must be a supported currency.
377
646
  * ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
378
647
  *
648
+ * example:
649
+ * EUR
379
650
  */
380
651
  Currency;
381
652
  /**
@@ -435,6 +706,10 @@ declare namespace Components {
435
706
  */
436
707
  recurrences?: (/* An amount associated with a specific recurrence. */ RecurrenceAmountDto)[];
437
708
  _price?: /* The price configuration */ Price;
709
+ /**
710
+ * The product linked to the price item.
711
+ */
712
+ _product?: /* The product configuration */ Product;
438
713
  }
439
714
  /**
440
715
  * Tracks a set of product prices, quantities, (discounts) and taxes.
@@ -469,6 +744,7 @@ declare namespace Components {
469
744
  name?: string;
470
745
  _id?: string;
471
746
  _title?: string;
747
+ _availability_files?: File[];
472
748
  }
473
749
  /**
474
750
  * An amount associated with a specific recurrence.
@@ -520,7 +796,7 @@ declare namespace Components {
520
796
  */
521
797
  amount_tax?: number;
522
798
  }
523
- export type SalexTax = "nontaxable" | "reduced" | "standard";
799
+ export type SalesTax = "nontaxable" | "reduced" | "standard";
524
800
  /**
525
801
  * the tax configuration
526
802
  */
@@ -593,56 +869,60 @@ declare namespace Components {
593
869
  }
594
870
  }
595
871
  declare namespace Paths {
596
- namespace $CheckoutCart {
872
+ namespace $AvailabilityCheck {
597
873
  export interface HeaderParameters {
598
874
  "X-Ivy-Org-ID": Parameters.XIvyOrgID;
599
875
  }
600
876
  namespace Parameters {
601
877
  export type XIvyOrgID = string;
602
878
  }
603
- export type RequestBody = /* The cart checkout request payload */ Components.Schemas.CheckoutCart;
879
+ export type RequestBody = /* Availability check request payload */ Components.Schemas.AvailabilityCheckParams;
604
880
  namespace Responses {
605
- export type $200 = /* The cart checkout result */ Components.Schemas.CheckoutCartResult;
881
+ export type $200 = /**
882
+ * The availability check result payload
883
+ * example:
884
+ * {
885
+ * "available_products": [],
886
+ * "check_results": [
887
+ * {
888
+ * "product_id": "my-product-id-123-1",
889
+ * "matching_hits": 0
890
+ * },
891
+ * {
892
+ * "product_id": "my-product-id-123-2",
893
+ * "matching_hits": 0
894
+ * }
895
+ * ]
896
+ * }
897
+ */
898
+ Components.Schemas.AvailabilityResult;
606
899
  export type $400 = Components.Schemas.Error;
607
900
  }
608
901
  }
609
- namespace $CreateOpportunity {
902
+ namespace $CheckoutCart {
610
903
  export interface HeaderParameters {
611
904
  "X-Ivy-Org-ID": Parameters.XIvyOrgID;
612
905
  }
613
906
  namespace Parameters {
614
907
  export type XIvyOrgID = string;
615
908
  }
616
- export type RequestBody = /* The opportunity entity */ Components.Schemas.Opportunity;
909
+ export type RequestBody = /* The cart checkout request payload */ Components.Schemas.CheckoutCart;
617
910
  namespace Responses {
618
- export type $201 = /* The opportunity entity */ Components.Schemas.Opportunity;
911
+ export type $200 = /* The cart checkout result */ Components.Schemas.CheckoutCartResult;
619
912
  export type $400 = Components.Schemas.Error;
620
913
  }
621
914
  }
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;
915
+ namespace $CreateOpportunity {
916
+ export interface HeaderParameters {
917
+ "X-Ivy-Org-ID": Parameters.XIvyOrgID;
632
918
  }
633
- }
634
- namespace $GetCart {
635
919
  namespace Parameters {
636
- export type CartId = string;
637
- }
638
- export interface PathParameters {
639
- "cart-id": Parameters.CartId;
920
+ export type XIvyOrgID = string;
640
921
  }
922
+ export type RequestBody = /* The opportunity entity */ Components.Schemas.Opportunity;
641
923
  namespace Responses {
642
- export type $200 = /* Supports shopping for products and services until ready for checkout. */ Components.Schemas.Cart;
924
+ export type $201 = /* The opportunity entity */ Components.Schemas.Opportunity;
643
925
  export type $400 = Components.Schemas.Error;
644
- export interface $404 {
645
- }
646
926
  }
647
927
  }
648
928
  namespace $SearchCatalog {
@@ -659,7 +939,18 @@ declare namespace Paths {
659
939
  * "q": "_id:1233432 OR _id:123432454 OR _id:23445433",
660
940
  * "sort": "description ASC",
661
941
  * "from": 0,
662
- * "size": 200
942
+ * "size": 200,
943
+ * "availability": {
944
+ * "location": {
945
+ * "postal_code": "57008,",
946
+ * "city": "Cologne,",
947
+ * "street": "Media Park,",
948
+ * "street_number": "8a"
949
+ * },
950
+ * "available_date": {
951
+ * "value": "2022-05-01"
952
+ * }
953
+ * }
663
954
  * }
664
955
  */
665
956
  Components.Schemas.CatalogSearch;
@@ -685,25 +976,23 @@ declare namespace Paths {
685
976
  export type $400 = Components.Schemas.Error;
686
977
  }
687
978
  }
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;
979
+ namespace CreateOrder {
980
+ export type RequestBody = /* Order Entity Payload */ Components.Schemas.OrderPayload;
696
981
  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;
982
+ export type $201 = /* The order entity */ Components.Schemas.Order;
699
983
  export type $400 = Components.Schemas.Error;
700
984
  }
701
985
  }
702
- namespace $UpsertOrder {
703
- export type RequestBody = /* The order entity */ Components.Schemas.Order;
986
+ namespace PutOrder {
987
+ namespace Parameters {
988
+ export type Id = string;
989
+ }
990
+ export interface PathParameters {
991
+ id: Parameters.Id;
992
+ }
993
+ export type RequestBody = /* Order Entity Payload */ Components.Schemas.OrderPayload;
704
994
  namespace Responses {
705
995
  export type $200 = /* The order entity */ Components.Schemas.Order;
706
- export type $201 = /* The order entity */ Components.Schemas.Order;
707
996
  export type $400 = Components.Schemas.Error;
708
997
  }
709
998
  }
@@ -711,15 +1000,25 @@ declare namespace Paths {
711
1000
 
712
1001
  export interface OperationMethods {
713
1002
  /**
714
- * $upsertCart - upsertCart
1003
+ * createOrder - createOrder
1004
+ *
1005
+ * Create an order
1006
+ */
1007
+ 'createOrder'(
1008
+ parameters?: Parameters<UnknownParamsObject> | null,
1009
+ data?: Paths.CreateOrder.RequestBody,
1010
+ config?: AxiosRequestConfig
1011
+ ): OperationResponse<Paths.CreateOrder.Responses.$201>
1012
+ /**
1013
+ * putOrder - putOrder
715
1014
  *
716
- * Creates a new cart or updates an existing one.
1015
+ * Update an existing Order
717
1016
  */
718
- '$upsertCart'(
719
- parameters?: Parameters<Paths.$UpsertCart.HeaderParameters> | null,
720
- data?: Paths.$UpsertCart.RequestBody,
1017
+ 'putOrder'(
1018
+ parameters?: Parameters<Paths.PutOrder.PathParameters> | null,
1019
+ data?: Paths.PutOrder.RequestBody,
721
1020
  config?: AxiosRequestConfig
722
- ): OperationResponse<Paths.$UpsertCart.Responses.$200 | Paths.$UpsertCart.Responses.$201>
1021
+ ): OperationResponse<Paths.PutOrder.Responses.$200>
723
1022
  /**
724
1023
  * $checkoutCart - checkoutCart
725
1024
  *
@@ -741,44 +1040,6 @@ export interface OperationMethods {
741
1040
  data?: Paths.$CheckoutCart.RequestBody,
742
1041
  config?: AxiosRequestConfig
743
1042
  ): 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
1043
  /**
783
1044
  * $searchCatalog - searchCatalog
784
1045
  *
@@ -789,10 +1050,20 @@ export interface OperationMethods {
789
1050
  data?: Paths.$SearchCatalog.RequestBody,
790
1051
  config?: AxiosRequestConfig
791
1052
  ): OperationResponse<Paths.$SearchCatalog.Responses.$200>
1053
+ /**
1054
+ * $availabilityCheck - availabilityCheck
1055
+ *
1056
+ * The availability check endpoint
1057
+ */
1058
+ '$availabilityCheck'(
1059
+ parameters?: Parameters<Paths.$AvailabilityCheck.HeaderParameters> | null,
1060
+ data?: Paths.$AvailabilityCheck.RequestBody,
1061
+ config?: AxiosRequestConfig
1062
+ ): OperationResponse<Paths.$AvailabilityCheck.Responses.$200>
792
1063
  /**
793
1064
  * $createOpportunity - createOpportunity
794
1065
  *
795
- * Creates a new opportunity. During the creation of an opportunity, an unique customer-readable `opportunity_number` will be generated.
1066
+ * 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
1067
  * The `opportunity_number` can be used to universally identify an opportunity within epilot platform.
797
1068
  *
798
1069
  */
@@ -804,17 +1075,29 @@ export interface OperationMethods {
804
1075
  }
805
1076
 
806
1077
  export interface PathsDictionary {
807
- ['/v1/public/cart']: {
1078
+ ['/v1/order']: {
1079
+ /**
1080
+ * createOrder - createOrder
1081
+ *
1082
+ * Create an order
1083
+ */
1084
+ 'post'(
1085
+ parameters?: Parameters<UnknownParamsObject> | null,
1086
+ data?: Paths.CreateOrder.RequestBody,
1087
+ config?: AxiosRequestConfig
1088
+ ): OperationResponse<Paths.CreateOrder.Responses.$201>
1089
+ }
1090
+ ['/v1/order/{id}']: {
808
1091
  /**
809
- * $upsertCart - upsertCart
1092
+ * putOrder - putOrder
810
1093
  *
811
- * Creates a new cart or updates an existing one.
1094
+ * Update an existing Order
812
1095
  */
813
1096
  'put'(
814
- parameters?: Parameters<Paths.$UpsertCart.HeaderParameters> | null,
815
- data?: Paths.$UpsertCart.RequestBody,
1097
+ parameters?: Parameters<Paths.PutOrder.PathParameters> | null,
1098
+ data?: Paths.PutOrder.RequestBody,
816
1099
  config?: AxiosRequestConfig
817
- ): OperationResponse<Paths.$UpsertCart.Responses.$200 | Paths.$UpsertCart.Responses.$201>
1100
+ ): OperationResponse<Paths.PutOrder.Responses.$200>
818
1101
  }
819
1102
  ['/v1/public/cart:checkout']: {
820
1103
  /**
@@ -839,48 +1122,6 @@ export interface PathsDictionary {
839
1122
  config?: AxiosRequestConfig
840
1123
  ): OperationResponse<Paths.$CheckoutCart.Responses.$200>
841
1124
  }
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
1125
  ['/v1/public/catalog']: {
885
1126
  /**
886
1127
  * $searchCatalog - searchCatalog
@@ -893,11 +1134,23 @@ export interface PathsDictionary {
893
1134
  config?: AxiosRequestConfig
894
1135
  ): OperationResponse<Paths.$SearchCatalog.Responses.$200>
895
1136
  }
1137
+ ['/v1/public/availability:check']: {
1138
+ /**
1139
+ * $availabilityCheck - availabilityCheck
1140
+ *
1141
+ * The availability check endpoint
1142
+ */
1143
+ 'post'(
1144
+ parameters?: Parameters<Paths.$AvailabilityCheck.HeaderParameters> | null,
1145
+ data?: Paths.$AvailabilityCheck.RequestBody,
1146
+ config?: AxiosRequestConfig
1147
+ ): OperationResponse<Paths.$AvailabilityCheck.Responses.$200>
1148
+ }
896
1149
  ['/v1/public/opportunity']: {
897
1150
  /**
898
1151
  * $createOpportunity - createOpportunity
899
1152
  *
900
- * Creates a new opportunity. During the creation of an opportunity, an unique customer-readable `opportunity_number` will be generated.
1153
+ * 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
1154
  * The `opportunity_number` can be used to universally identify an opportunity within epilot platform.
902
1155
  *
903
1156
  */