@teemill/orders 1.21.0 → 1.22.0

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/api.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Orders API
5
5
  * Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
6
6
  *
7
- * The version of the OpenAPI document: 1.21.0
7
+ * The version of the OpenAPI document: 1.22.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -25,146 +25,75 @@ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerM
25
25
 
26
26
  /**
27
27
  * A person\'s address.
28
- * @export
29
- * @interface Address
30
28
  */
31
29
  export interface Address {
32
- /**
33
- *
34
- * @type {string}
35
- * @memberof Address
36
- */
37
30
  'contactName'?: string;
38
- /**
39
- *
40
- * @type {string}
41
- * @memberof Address
42
- */
43
31
  'company'?: string;
44
32
  /**
45
33
  * First line of the address.
46
- * @type {string}
47
- * @memberof Address
48
34
  */
49
35
  'line1'?: string;
50
36
  /**
51
37
  * Second line of the address.
52
- * @type {string}
53
- * @memberof Address
54
38
  */
55
39
  'line2'?: string;
56
40
  /**
57
41
  * City of the address.
58
- * @type {string}
59
- * @memberof Address
60
42
  */
61
43
  'city'?: string;
62
44
  /**
63
45
  * Postal code of the address.
64
- * @type {string}
65
- * @memberof Address
66
46
  */
67
47
  'postalCode'?: string;
68
48
  /**
69
49
  * Country of the address (ISO 3166-1 alpha-2).
70
- * @type {string}
71
- * @memberof Address
72
50
  */
73
51
  'country': string;
74
52
  /**
75
53
  * State of the address. If the country is Canada, Australia, or the United States, this field is required.
76
- * @type {string}
77
- * @memberof Address
78
54
  */
79
55
  'state'?: string;
80
56
  }
81
- /**
82
- *
83
- * @export
84
- * @interface ApiError
85
- */
86
57
  export interface ApiError {
87
- /**
88
- *
89
- * @type {string}
90
- * @memberof ApiError
91
- */
92
58
  'code'?: string;
93
- /**
94
- *
95
- * @type {string}
96
- * @memberof ApiError
97
- */
98
59
  'message': string;
99
60
  }
100
61
  /**
101
- *
102
- * @export
103
- * @interface ConfirmOrderFulfillment
62
+ * @type ConfirmOrderFulfillment
104
63
  */
105
- export interface ConfirmOrderFulfillment {
64
+ export type ConfirmOrderFulfillment = ConfirmOrderFulfillmentWithShipment | ConfirmOrderFulfillmentWithShippingMethod;
65
+
66
+ export interface ConfirmOrderFulfillmentWithShipment {
106
67
  /**
107
68
  * Unique object identifier
108
- * @type {string}
109
- * @memberof ConfirmOrderFulfillment
110
69
  */
111
70
  'fulfillmentId': string;
112
- /**
113
- * Unique object identifier
114
- * @type {string}
115
- * @memberof ConfirmOrderFulfillment
116
- */
117
- 'shippingMethodId'?: string;
118
- /**
119
- *
120
- * @type {ConfirmOrderFulfillmentShipment}
121
- * @memberof ConfirmOrderFulfillment
122
- */
123
- 'shipment'?: ConfirmOrderFulfillmentShipment;
71
+ 'shipment': ConfirmOrderFulfillmentWithShipmentShipment;
124
72
  }
125
73
  /**
126
74
  * This field is only required if you are using your own shipping label.
127
- * @export
128
- * @interface ConfirmOrderFulfillmentShipment
129
75
  */
130
- export interface ConfirmOrderFulfillmentShipment {
76
+ export interface ConfirmOrderFulfillmentWithShipmentShipment {
131
77
  /**
132
78
  * Only required if you are generating shipping labels outside of PodOS
133
- * @type {string}
134
- * @memberof ConfirmOrderFulfillmentShipment
135
79
  */
136
80
  'image': string;
137
81
  }
138
- /**
139
- *
140
- * @export
141
- * @interface ConfirmOrderRequest
142
- */
143
- export interface ConfirmOrderRequest {
82
+ export interface ConfirmOrderFulfillmentWithShippingMethod {
144
83
  /**
145
- *
146
- * @type {Array<ConfirmOrderFulfillment>}
147
- * @memberof ConfirmOrderRequest
84
+ * Unique object identifier
148
85
  */
86
+ 'fulfillmentId': string;
87
+ /**
88
+ * Unique object identifier
89
+ */
90
+ 'shippingMethodId': string;
91
+ }
92
+ export interface ConfirmOrderRequest {
149
93
  'fulfillments': Array<ConfirmOrderFulfillment>;
150
94
  }
151
- /**
152
- *
153
- * @export
154
- * @interface ConfirmOrderValidationError
155
- */
156
95
  export interface ConfirmOrderValidationError {
157
- /**
158
- *
159
- * @type {string}
160
- * @memberof ConfirmOrderValidationError
161
- */
162
96
  'code': ConfirmOrderValidationErrorCodeEnum;
163
- /**
164
- *
165
- * @type {string}
166
- * @memberof ConfirmOrderValidationError
167
- */
168
97
  'message': string;
169
98
  }
170
99
 
@@ -179,138 +108,67 @@ export type ConfirmOrderValidationErrorCodeEnum = typeof ConfirmOrderValidationE
179
108
 
180
109
  /**
181
110
  * Order recipient contact information, used only for courier tracking/updates.
182
- * @export
183
- * @interface ContactInformation
184
111
  */
185
112
  export interface ContactInformation {
186
- /**
187
- *
188
- * @type {string}
189
- * @memberof ContactInformation
190
- */
191
113
  'email': string;
192
- /**
193
- *
194
- * @type {string}
195
- * @memberof ContactInformation
196
- */
197
114
  'phone'?: string | null;
198
115
  }
199
116
  /**
200
117
  * Coupon applied to the order.
201
- * @export
202
- * @interface Coupon
203
118
  */
204
119
  export interface Coupon {
205
120
  /**
206
121
  * Unique object identifier
207
- * @type {string}
208
- * @memberof Coupon
209
122
  */
210
123
  'id': string;
211
- /**
212
- *
213
- * @type {string}
214
- * @memberof Coupon
215
- */
216
124
  'code': string;
217
125
  /**
218
126
  * Reference to the discount. **Note:** Requires the discounts integration to see the reference.
219
- * @type {string}
220
- * @memberof Coupon
221
127
  */
222
128
  'ref'?: string | null;
223
129
  }
224
130
  /**
225
131
  * Create an order
226
- * @export
227
- * @interface CreateOrder
228
132
  */
229
133
  export interface CreateOrder {
230
134
  /**
231
135
  * A custom reference to the merchant\'s order.
232
- * @type {string}
233
- * @memberof CreateOrder
234
136
  */
235
137
  'merchantReference'?: string | null;
236
- /**
237
- *
238
- * @type {CreateOrderContactInformation}
239
- * @memberof CreateOrder
240
- */
241
138
  'contactInformation': CreateOrderContactInformation;
242
- /**
243
- *
244
- * @type {Address}
245
- * @memberof CreateOrder
246
- */
247
139
  'shippingAddress': Address;
248
- /**
249
- *
250
- * @type {CustomsInformation}
251
- * @memberof CreateOrder
252
- */
253
140
  'customsInformation'?: CustomsInformation;
254
141
  /**
255
142
  * Items to be ordered
256
- * @type {Array<OrderItem1>}
257
- * @memberof CreateOrder
258
143
  */
259
144
  'items': Array<OrderItem1>;
260
- /**
261
- *
262
- * @type {Array<string>}
263
- * @memberof CreateOrder
264
- */
265
145
  'preferredFulfillers'?: Array<string>;
266
146
  }
267
147
  /**
268
148
  * Contact information for the order
269
- * @export
270
- * @interface CreateOrderContactInformation
271
149
  */
272
150
  export interface CreateOrderContactInformation {
273
- /**
274
- *
275
- * @type {string}
276
- * @memberof CreateOrderContactInformation
277
- */
278
151
  'email': string;
279
- /**
280
- *
281
- * @type {string}
282
- * @memberof CreateOrderContactInformation
283
- */
284
152
  'phone'?: string | null;
285
153
  }
286
154
  /**
287
155
  * Customs information for the order. **Note:** Adding customs information to an order is only compatible with Shipmate at this time
288
- * @export
289
- * @interface CustomsInformation
290
156
  */
291
157
  export interface CustomsInformation {
292
158
  /**
293
159
  * Pre-registration type
294
- * @type {string}
295
- * @memberof CustomsInformation
296
160
  */
297
161
  'preRegistrationType'?: CustomsInformationPreRegistrationTypeEnum;
298
162
  /**
299
163
  * Pre-registration number
300
- * @type {string}
301
- * @memberof CustomsInformation
302
164
  */
303
165
  'preRegistrationNumber'?: string;
304
166
  /**
305
167
  * VAT number
306
- * @type {string}
307
- * @memberof CustomsInformation
308
168
  */
309
169
  'vatNumber'?: string;
310
170
  /**
311
171
  * EORI number
312
- * @type {string}
313
- * @memberof CustomsInformation
314
172
  */
315
173
  'eoriNumber'?: string;
316
174
  }
@@ -321,127 +179,51 @@ export const CustomsInformationPreRegistrationTypeEnum = {
321
179
 
322
180
  export type CustomsInformationPreRegistrationTypeEnum = typeof CustomsInformationPreRegistrationTypeEnum[keyof typeof CustomsInformationPreRegistrationTypeEnum];
323
181
 
324
- /**
325
- *
326
- * @export
327
- * @interface CustomsInformation1
328
- */
329
182
  export interface CustomsInformation1 {
330
- /**
331
- *
332
- * @type {string}
333
- * @memberof CustomsInformation1
334
- */
335
183
  'preRegistrationType'?: string;
336
- /**
337
- *
338
- * @type {string}
339
- * @memberof CustomsInformation1
340
- */
341
184
  'preRegistrationNumber'?: string;
342
- /**
343
- *
344
- * @type {string}
345
- * @memberof CustomsInformation1
346
- */
347
185
  'vatNumber'?: string;
348
- /**
349
- *
350
- * @type {string}
351
- * @memberof CustomsInformation1
352
- */
353
186
  'eoriNumber'?: string;
354
187
  }
355
- /**
356
- *
357
- * @export
358
- * @interface DeliveryEstimates
359
- */
360
188
  export interface DeliveryEstimates {
361
189
  /**
362
190
  * Whether this is a priority shipping method. Fulfillments with priority methods aim for same day dispatch when ordered before 1pm, and typically offer faster delivery times.
363
- * @type {boolean}
364
- * @memberof DeliveryEstimates
365
191
  */
366
192
  'isPriority'?: boolean;
367
193
  /**
368
194
  * ISO 8601 Timestamp
369
- * @type {string}
370
- * @memberof DeliveryEstimates
371
195
  */
372
196
  'min'?: string;
373
197
  /**
374
198
  * ISO 8601 Timestamp
375
- * @type {string}
376
- * @memberof DeliveryEstimates
377
199
  */
378
200
  'max'?: string;
379
201
  }
380
- /**
381
- *
382
- * @export
383
- * @interface ExportOrders202Response
384
- */
385
202
  export interface ExportOrders202Response {
386
203
  /**
387
204
  * A message describing the export status
388
- * @type {string}
389
- * @memberof ExportOrders202Response
390
205
  */
391
206
  'message'?: string;
392
207
  }
393
- /**
394
- *
395
- * @export
396
- * @interface Fulfillment
397
- */
398
208
  export interface Fulfillment {
399
209
  /**
400
210
  * Unique fulfillment id
401
- * @type {string}
402
- * @memberof Fulfillment
403
211
  */
404
212
  'id'?: string;
405
- /**
406
- *
407
- * @type {Status}
408
- * @memberof Fulfillment
409
- */
410
213
  'status'?: Status;
411
- /**
412
- *
413
- * @type {FulfillmentFulfiller}
414
- * @memberof Fulfillment
415
- */
416
214
  'fulfiller'?: FulfillmentFulfiller;
417
- /**
418
- *
419
- * @type {Array<FulfillmentItem>}
420
- * @memberof Fulfillment
421
- */
422
215
  'items'?: Array<FulfillmentItem>;
423
- /**
424
- *
425
- * @type {OrderTracking}
426
- * @memberof Fulfillment
427
- */
428
216
  'tracking'?: OrderTracking | null;
429
217
  /**
430
218
  * Shipping method currently set
431
- * @type {ShippingMethod}
432
- * @memberof Fulfillment
433
219
  */
434
220
  'shippingMethod'?: ShippingMethod;
435
221
  /**
436
222
  * Shipping methods available for this fulfillment. One of these should be used to confirm the fulfillment.
437
- * @type {Array<ShippingMethod>}
438
- * @memberof Fulfillment
439
223
  */
440
224
  'availableShippingMethods'?: Array<ShippingMethod>;
441
225
  /**
442
226
  * Weight of the package being shipped in grams
443
- * @type {number}
444
- * @memberof Fulfillment
445
227
  */
446
228
  'packageWeight'?: number;
447
229
  }
@@ -449,472 +231,170 @@ export interface Fulfillment {
449
231
 
450
232
  /**
451
233
  * The fulfiller that will be processing this order.
452
- * @export
453
- * @interface FulfillmentFulfiller
454
234
  */
455
235
  export interface FulfillmentFulfiller {
456
236
  /**
457
237
  * Unique object identifier
458
- * @type {string}
459
- * @memberof FulfillmentFulfiller
460
238
  */
461
239
  'id'?: string;
462
- /**
463
- *
464
- * @type {FulfillmentFulfillerLocation}
465
- * @memberof FulfillmentFulfiller
466
- */
467
240
  'location'?: FulfillmentFulfillerLocation;
468
241
  }
469
- /**
470
- *
471
- * @export
472
- * @interface FulfillmentFulfillerLocation
473
- */
474
242
  export interface FulfillmentFulfillerLocation {
475
- /**
476
- *
477
- * @type {string}
478
- * @memberof FulfillmentFulfillerLocation
479
- */
480
243
  'city'?: string | null;
481
- /**
482
- *
483
- * @type {string}
484
- * @memberof FulfillmentFulfillerLocation
485
- */
486
244
  'country'?: string | null;
487
245
  }
488
- /**
489
- *
490
- * @export
491
- * @interface FulfillmentItem
492
- */
493
246
  export interface FulfillmentItem {
494
247
  /**
495
248
  * Unique fulfillment item id
496
- * @type {string}
497
- * @memberof FulfillmentItem
498
249
  */
499
250
  'id'?: string;
500
251
  /**
501
252
  * Id of the order item being fulfilled
502
- * @type {string}
503
- * @memberof FulfillmentItem
504
253
  */
505
254
  'itemId'?: string;
506
255
  /**
507
256
  * Number of this item being fulfilled
508
- * @type {number}
509
- * @memberof FulfillmentItem
510
257
  */
511
258
  'quantity'?: number;
512
259
  }
513
260
  /**
514
261
  * Image description
515
- * @export
516
- * @interface Image
517
262
  */
518
263
  export interface Image {
519
264
  /**
520
265
  * Unique object identifier
521
- * @type {string}
522
- * @memberof Image
523
266
  */
524
267
  'id'?: string;
525
- /**
526
- *
527
- * @type {string}
528
- * @memberof Image
529
- */
530
268
  'src'?: string;
531
- /**
532
- *
533
- * @type {string}
534
- * @memberof Image
535
- */
536
269
  'alt'?: string;
537
- /**
538
- *
539
- * @type {number}
540
- * @memberof Image
541
- */
542
270
  'sortOrder'?: number;
543
271
  }
544
- /**
545
- *
546
- * @export
547
- * @interface Option
548
- */
549
272
  export interface Option {
550
273
  /**
551
274
  * Option name
552
- * @type {string}
553
- * @memberof Option
554
275
  */
555
276
  'name': string;
556
277
  /**
557
278
  * Option value
558
- * @type {string}
559
- * @memberof Option
560
279
  */
561
280
  'value': string;
562
281
  }
563
- /**
564
- *
565
- * @export
566
- * @interface Order
567
- */
568
282
  export interface Order {
569
283
  /**
570
284
  * Unique object identifier
571
- * @type {string}
572
- * @memberof Order
573
285
  */
574
286
  'id'?: string;
575
287
  /**
576
288
  * A reference to the resource location
577
- * @type {string}
578
- * @memberof Order
579
289
  */
580
290
  'ref'?: string;
581
- /**
582
- *
583
- * @type {Status}
584
- * @memberof Order
585
- */
586
291
  'status'?: Status;
587
- /**
588
- *
589
- * @type {ContactInformation}
590
- * @memberof Order
591
- */
592
292
  'contactInformation': ContactInformation;
593
- /**
594
- *
595
- * @type {PaymentMethod}
596
- * @memberof Order
597
- */
598
293
  'paymentMethod'?: PaymentMethod;
599
- /**
600
- *
601
- * @type {Address}
602
- * @memberof Order
603
- */
604
294
  'shippingAddress': Address;
605
- /**
606
- *
607
- * @type {CustomsInformation1}
608
- * @memberof Order
609
- */
610
295
  'customsInformation'?: CustomsInformation1;
611
296
  /**
612
297
  * ISO 8601 Timestamp
613
- * @type {string}
614
- * @memberof Order
615
298
  */
616
299
  'createdAt'?: string;
617
300
  /**
618
301
  * ISO 8601 Timestamp
619
- * @type {string}
620
- * @memberof Order
621
302
  */
622
303
  'updatedAt'?: string;
623
304
  /**
624
305
  * ISO 8601 Timestamp
625
- * @type {string}
626
- * @memberof Order
627
306
  */
628
307
  'statusChangedAt'?: string;
629
308
  /**
630
309
  * A custom reference to the merchant\'s order.
631
- * @type {string}
632
- * @memberof Order
633
310
  */
634
311
  'merchantReference'?: string | null;
635
- /**
636
- *
637
- * @type {Array<Fulfillment>}
638
- * @memberof Order
639
- */
640
312
  'fulfillments'?: Array<Fulfillment>;
641
- /**
642
- *
643
- * @type {Array<OrderItem>}
644
- * @memberof Order
645
- */
646
313
  'items': Array<OrderItem>;
647
- /**
648
- *
649
- * @type {Price}
650
- * @memberof Order
651
- */
652
314
  'totalPrice'?: Price;
653
- /**
654
- *
655
- * @type {Price}
656
- * @memberof Order
657
- */
658
315
  'taxPrice'?: Price;
659
- /**
660
- *
661
- * @type {Price}
662
- * @memberof Order
663
- */
664
316
  'subtotalPrice'?: Price;
665
- /**
666
- *
667
- * @type {Price}
668
- * @memberof Order
669
- */
670
317
  'discountPrice'?: Price;
671
- /**
672
- *
673
- * @type {Coupon}
674
- * @memberof Order
675
- */
676
318
  'coupon'?: Coupon | null;
677
- /**
678
- *
679
- * @type {Price}
680
- * @memberof Order
681
- */
682
319
  'shippingPrice'?: Price;
683
- /**
684
- *
685
- * @type {Origin}
686
- * @memberof Order
687
- */
688
320
  'origin'?: Origin;
689
- /**
690
- *
691
- * @type {Array<StatusHistoryItem>}
692
- * @memberof Order
693
- */
694
321
  'statusHistory'?: Array<StatusHistoryItem>;
695
- /**
696
- *
697
- * @type {Array<PaymentAttempt>}
698
- * @memberof Order
699
- */
700
322
  'paymentAttempts'?: Array<PaymentAttempt>;
701
323
  }
702
324
 
703
325
 
704
- /**
705
- *
706
- * @export
707
- * @interface OrderItem
708
- */
709
326
  export interface OrderItem {
710
327
  /**
711
328
  * Unique object identifier
712
- * @type {string}
713
- * @memberof OrderItem
714
329
  */
715
330
  'id'?: string;
716
331
  /**
717
332
  * A reference to the variant being ordered
718
- * @type {string}
719
- * @memberof OrderItem
720
333
  */
721
334
  'variantRef': string;
722
335
  /**
723
336
  * Options associated to an order item\'s variant, such as color and size.
724
- * @type {Array<Option>}
725
- * @memberof OrderItem
726
337
  */
727
338
  'options'?: Array<Option>;
728
- /**
729
- *
730
- * @type {number}
731
- * @memberof OrderItem
732
- */
733
339
  'quantity': number;
734
340
  /**
735
341
  * The name of the product
736
- * @type {string}
737
- * @memberof OrderItem
738
342
  */
739
343
  'name'?: string;
740
344
  /**
741
345
  * Images
742
- * @type {Array<Image>}
743
- * @memberof OrderItem
744
346
  */
745
347
  'images'?: Array<Image>;
746
- /**
747
- *
748
- * @type {Price}
749
- * @memberof OrderItem
750
- */
751
348
  'totalPrice'?: Price;
752
349
  /**
753
350
  * This is an estimate until the order has been confirmed
754
- * @type {Price}
755
- * @memberof OrderItem
756
351
  */
757
352
  'taxPrice'?: Price;
758
- /**
759
- *
760
- * @type {Price}
761
- * @memberof OrderItem
762
- */
763
353
  'subtotalPrice'?: Price;
764
- /**
765
- *
766
- * @type {Price}
767
- * @memberof OrderItem
768
- */
769
354
  'discountPrice'?: Price;
770
355
  /**
771
356
  * The price you charged the recipient for each item. It\'s highly recommended if you have international orders as it aids customs issues.
772
- * @type {Price}
773
- * @memberof OrderItem
774
357
  */
775
358
  'recipientCost'?: Price;
776
359
  }
777
- /**
778
- *
779
- * @export
780
- * @interface OrderItem1
781
- */
782
360
  export interface OrderItem1 {
783
361
  /**
784
362
  * A reference to the variant being ordered
785
- * @type {string}
786
- * @memberof OrderItem1
787
363
  */
788
364
  'variantRef': string;
789
- /**
790
- *
791
- * @type {number}
792
- * @memberof OrderItem1
793
- */
794
365
  'quantity': number;
795
- /**
796
- *
797
- * @type {OrderItem1RecipientCost}
798
- * @memberof OrderItem1
799
- */
800
366
  'recipientCost'?: OrderItem1RecipientCost;
801
367
  }
802
- /**
803
- *
804
- * @export
805
- * @interface OrderItem1RecipientCost
806
- */
807
368
  export interface OrderItem1RecipientCost {
808
- /**
809
- *
810
- * @type {string}
811
- * @memberof OrderItem1RecipientCost
812
- */
813
369
  'amount': string;
814
- /**
815
- *
816
- * @type {string}
817
- * @memberof OrderItem1RecipientCost
818
- */
819
370
  'currencyCode': string;
820
371
  }
821
- /**
822
- *
823
- * @export
824
- * @interface OrderTracking
825
- */
826
372
  export interface OrderTracking {
827
- /**
828
- *
829
- * @type {string}
830
- * @memberof OrderTracking
831
- */
832
373
  'courier'?: string;
833
- /**
834
- *
835
- * @type {string}
836
- * @memberof OrderTracking
837
- */
838
374
  'code'?: string;
839
- /**
840
- *
841
- * @type {string}
842
- * @memberof OrderTracking
843
- */
844
375
  'url'?: string;
845
376
  }
846
- /**
847
- *
848
- * @export
849
- * @interface OrdersResponse
850
- */
851
377
  export interface OrdersResponse {
852
- /**
853
- *
854
- * @type {Array<Order>}
855
- * @memberof OrdersResponse
856
- */
857
378
  'orders'?: Array<Order>;
858
379
  /**
859
380
  * The token referencing the next page number
860
- * @type {number}
861
- * @memberof OrdersResponse
862
381
  */
863
382
  'nextPageToken'?: number | null;
864
383
  }
865
- /**
866
- *
867
- * @export
868
- * @interface Origin
869
- */
870
384
  export interface Origin {
871
- /**
872
- *
873
- * @type {string}
874
- * @memberof Origin
875
- */
876
385
  'code'?: string;
877
- /**
878
- *
879
- * @type {boolean}
880
- * @memberof Origin
881
- */
882
386
  'isPaid'?: boolean;
883
387
  }
884
388
  /**
885
389
  * List of payment attempts for this order
886
- * @export
887
- * @interface PaymentAttempt
888
390
  */
889
391
  export interface PaymentAttempt {
890
- /**
891
- *
892
- * @type {string}
893
- * @memberof PaymentAttempt
894
- */
895
392
  'paymentProvider'?: PaymentAttemptPaymentProviderEnum;
896
- /**
897
- *
898
- * @type {string}
899
- * @memberof PaymentAttempt
900
- */
901
393
  'status'?: PaymentAttemptStatusEnum;
902
- /**
903
- *
904
- * @type {string}
905
- * @memberof PaymentAttempt
906
- */
907
394
  'transactionId'?: string | null;
908
- /**
909
- *
910
- * @type {string}
911
- * @memberof PaymentAttempt
912
- */
913
395
  'message'?: string;
914
396
  /**
915
397
  * ISO 8601 Timestamp
916
- * @type {string}
917
- * @memberof PaymentAttempt
918
398
  */
919
399
  'createdAt'?: string;
920
400
  }
@@ -935,98 +415,35 @@ export const PaymentAttemptStatusEnum = {
935
415
 
936
416
  export type PaymentAttemptStatusEnum = typeof PaymentAttemptStatusEnum[keyof typeof PaymentAttemptStatusEnum];
937
417
 
938
- /**
939
- *
940
- * @export
941
- * @interface PaymentMethod
942
- */
943
418
  export interface PaymentMethod {
944
- /**
945
- *
946
- * @type {string}
947
- * @memberof PaymentMethod
948
- */
949
419
  'type'?: string;
950
420
  }
951
421
  /**
952
422
  * Standard price definition that defines the amount and currency.
953
- * @export
954
- * @interface Price
955
423
  */
956
424
  export interface Price {
957
425
  /**
958
426
  * Price including tax in the specified currency.
959
- * @type {string}
960
- * @memberof Price
961
427
  */
962
428
  'amount'?: string;
963
429
  /**
964
430
  * Currency code for the currency the price is valued in.
965
- * @type {string}
966
- * @memberof Price
967
431
  */
968
432
  'currencyCode'?: string;
969
433
  }
970
- /**
971
- *
972
- * @export
973
- * @interface ShippingMethod
974
- */
975
434
  export interface ShippingMethod {
976
435
  /**
977
436
  * Unique object identifier
978
- * @type {string}
979
- * @memberof ShippingMethod
980
437
  */
981
438
  'id'?: string;
982
- /**
983
- *
984
- * @type {string}
985
- * @memberof ShippingMethod
986
- */
987
439
  'name'?: string;
988
- /**
989
- *
990
- * @type {string}
991
- * @memberof ShippingMethod
992
- */
993
440
  'description'?: string;
994
- /**
995
- *
996
- * @type {DeliveryEstimates}
997
- * @memberof ShippingMethod
998
- */
999
441
  'deliveryEstimates'?: DeliveryEstimates;
1000
- /**
1001
- *
1002
- * @type {Price}
1003
- * @memberof ShippingMethod
1004
- */
1005
442
  'totalPrice'?: Price;
1006
- /**
1007
- *
1008
- * @type {Price}
1009
- * @memberof ShippingMethod
1010
- */
1011
443
  'taxPrice'?: Price;
1012
- /**
1013
- *
1014
- * @type {Price}
1015
- * @memberof ShippingMethod
1016
- */
1017
444
  'subtotalPrice'?: Price;
1018
- /**
1019
- *
1020
- * @type {Price}
1021
- * @memberof ShippingMethod
1022
- */
1023
445
  'discountPrice'?: Price;
1024
446
  }
1025
- /**
1026
- *
1027
- * @export
1028
- * @enum {string}
1029
- */
1030
447
 
1031
448
  export const Status = {
1032
449
  New: 'new',
@@ -1040,22 +457,10 @@ export const Status = {
1040
457
  export type Status = typeof Status[keyof typeof Status];
1041
458
 
1042
459
 
1043
- /**
1044
- *
1045
- * @export
1046
- * @interface StatusHistoryItem
1047
- */
1048
460
  export interface StatusHistoryItem {
1049
- /**
1050
- *
1051
- * @type {Status}
1052
- * @memberof StatusHistoryItem
1053
- */
1054
461
  'status'?: Status;
1055
462
  /**
1056
463
  * ISO 8601 Timestamp
1057
- * @type {string}
1058
- * @memberof StatusHistoryItem
1059
464
  */
1060
465
  'createdAt'?: string;
1061
466
  }
@@ -1064,7 +469,6 @@ export interface StatusHistoryItem {
1064
469
 
1065
470
  /**
1066
471
  * OrdersApi - axios parameter creator
1067
- * @export
1068
472
  */
1069
473
  export const OrdersApiAxiosParamCreator = function (configuration?: Configuration) {
1070
474
  return {
@@ -1552,7 +956,6 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
1552
956
 
1553
957
  /**
1554
958
  * OrdersApi - functional programming interface
1555
- * @export
1556
959
  */
1557
960
  export const OrdersApiFp = function(configuration?: Configuration) {
1558
961
  const localVarAxiosParamCreator = OrdersApiAxiosParamCreator(configuration)
@@ -1690,7 +1093,6 @@ export const OrdersApiFp = function(configuration?: Configuration) {
1690
1093
 
1691
1094
  /**
1692
1095
  * OrdersApi - factory interface
1693
- * @export
1694
1096
  */
1695
1097
  export const OrdersApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
1696
1098
  const localVarFp = OrdersApiFp(configuration)
@@ -1780,289 +1182,206 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
1780
1182
 
1781
1183
  /**
1782
1184
  * Request parameters for cancelOrder operation in OrdersApi.
1783
- * @export
1784
- * @interface OrdersApiCancelOrderRequest
1785
1185
  */
1786
1186
  export interface OrdersApiCancelOrderRequest {
1787
1187
  /**
1788
1188
  * What project it is
1789
- * @type {string}
1790
- * @memberof OrdersApiCancelOrder
1791
1189
  */
1792
1190
  readonly project: string
1793
1191
 
1794
1192
  /**
1795
1193
  * Unique identifier of an order
1796
- * @type {string}
1797
- * @memberof OrdersApiCancelOrder
1798
1194
  */
1799
1195
  readonly orderId: string
1800
1196
 
1801
1197
  /**
1802
1198
  * Specifies which fields to return, separated by commas
1803
- * @type {string}
1804
- * @memberof OrdersApiCancelOrder
1805
1199
  */
1806
1200
  readonly fields?: string
1807
1201
  }
1808
1202
 
1809
1203
  /**
1810
1204
  * Request parameters for confirmOrder operation in OrdersApi.
1811
- * @export
1812
- * @interface OrdersApiConfirmOrderRequest
1813
1205
  */
1814
1206
  export interface OrdersApiConfirmOrderRequest {
1815
1207
  /**
1816
1208
  * What project it is
1817
- * @type {string}
1818
- * @memberof OrdersApiConfirmOrder
1819
1209
  */
1820
1210
  readonly project: string
1821
1211
 
1822
1212
  /**
1823
1213
  * Unique identifier of an order
1824
- * @type {string}
1825
- * @memberof OrdersApiConfirmOrder
1826
1214
  */
1827
1215
  readonly orderId: string
1828
1216
 
1829
1217
  /**
1830
1218
  * ConfirmFulfillment schema
1831
- * @type {ConfirmOrderRequest}
1832
- * @memberof OrdersApiConfirmOrder
1833
1219
  */
1834
1220
  readonly confirmOrderRequest: ConfirmOrderRequest
1835
1221
 
1836
1222
  /**
1837
1223
  * Specifies which fields to return, separated by commas
1838
- * @type {string}
1839
- * @memberof OrdersApiConfirmOrder
1840
1224
  */
1841
1225
  readonly fields?: string
1842
1226
  }
1843
1227
 
1844
1228
  /**
1845
1229
  * Request parameters for createOrder operation in OrdersApi.
1846
- * @export
1847
- * @interface OrdersApiCreateOrderRequest
1848
1230
  */
1849
1231
  export interface OrdersApiCreateOrderRequest {
1850
1232
  /**
1851
1233
  * What project it is
1852
- * @type {string}
1853
- * @memberof OrdersApiCreateOrder
1854
1234
  */
1855
1235
  readonly project: string
1856
1236
 
1857
1237
  /**
1858
1238
  * Create Order schema
1859
- * @type {CreateOrder}
1860
- * @memberof OrdersApiCreateOrder
1861
1239
  */
1862
1240
  readonly createOrder: CreateOrder
1863
1241
 
1864
1242
  /**
1865
1243
  * Specifies which fields to return, separated by commas
1866
- * @type {string}
1867
- * @memberof OrdersApiCreateOrder
1868
1244
  */
1869
1245
  readonly fields?: string
1870
1246
  }
1871
1247
 
1872
1248
  /**
1873
1249
  * Request parameters for downloadInvoice operation in OrdersApi.
1874
- * @export
1875
- * @interface OrdersApiDownloadInvoiceRequest
1876
1250
  */
1877
1251
  export interface OrdersApiDownloadInvoiceRequest {
1878
1252
  /**
1879
1253
  * What project it is
1880
- * @type {string}
1881
- * @memberof OrdersApiDownloadInvoice
1882
1254
  */
1883
1255
  readonly project: string
1884
1256
 
1885
1257
  /**
1886
1258
  * Unique identifier of an order
1887
- * @type {string}
1888
- * @memberof OrdersApiDownloadInvoice
1889
1259
  */
1890
1260
  readonly orderId: string
1891
1261
  }
1892
1262
 
1893
1263
  /**
1894
1264
  * Request parameters for exportOrders operation in OrdersApi.
1895
- * @export
1896
- * @interface OrdersApiExportOrdersRequest
1897
1265
  */
1898
1266
  export interface OrdersApiExportOrdersRequest {
1899
1267
  /**
1900
1268
  * What project it is
1901
- * @type {string}
1902
- * @memberof OrdersApiExportOrders
1903
1269
  */
1904
1270
  readonly project: string
1905
1271
 
1906
1272
  /**
1907
1273
  * Start of date range to filter by when orders were placed
1908
- * @type {string}
1909
- * @memberof OrdersApiExportOrders
1910
1274
  */
1911
1275
  readonly start: string
1912
1276
 
1913
1277
  /**
1914
1278
  * End of date range
1915
- * @type {string}
1916
- * @memberof OrdersApiExportOrders
1917
1279
  */
1918
1280
  readonly end?: string
1919
1281
 
1920
1282
  /**
1921
1283
  * Search term to filter based on order reference, customer name and email
1922
- * @type {string}
1923
- * @memberof OrdersApiExportOrders
1924
1284
  */
1925
1285
  readonly search?: string
1926
1286
  }
1927
1287
 
1928
1288
  /**
1929
1289
  * Request parameters for getOrder operation in OrdersApi.
1930
- * @export
1931
- * @interface OrdersApiGetOrderRequest
1932
1290
  */
1933
1291
  export interface OrdersApiGetOrderRequest {
1934
1292
  /**
1935
1293
  * What project it is
1936
- * @type {string}
1937
- * @memberof OrdersApiGetOrder
1938
1294
  */
1939
1295
  readonly project: string
1940
1296
 
1941
1297
  /**
1942
1298
  * Unique identifier of an order
1943
- * @type {string}
1944
- * @memberof OrdersApiGetOrder
1945
1299
  */
1946
1300
  readonly orderId: string
1947
1301
 
1948
1302
  /**
1949
1303
  * Specifies which fields to return, separated by commas
1950
- * @type {string}
1951
- * @memberof OrdersApiGetOrder
1952
1304
  */
1953
1305
  readonly fields?: string
1954
1306
  }
1955
1307
 
1956
1308
  /**
1957
1309
  * Request parameters for getOrders operation in OrdersApi.
1958
- * @export
1959
- * @interface OrdersApiGetOrdersRequest
1960
1310
  */
1961
1311
  export interface OrdersApiGetOrdersRequest {
1962
1312
  /**
1963
1313
  * What project it is
1964
- * @type {string}
1965
- * @memberof OrdersApiGetOrders
1966
1314
  */
1967
1315
  readonly project: string
1968
1316
 
1969
1317
  /**
1970
1318
  * Specifies which fields to return, separated by commas
1971
- * @type {string}
1972
- * @memberof OrdersApiGetOrders
1973
1319
  */
1974
1320
  readonly fields?: string
1975
1321
 
1976
1322
  /**
1977
1323
  * Page reference token
1978
- * @type {number}
1979
- * @memberof OrdersApiGetOrders
1980
1324
  */
1981
1325
  readonly pageToken?: number
1982
1326
 
1983
1327
  /**
1984
1328
  * Max page size. This is the maximum page size that will be returned, but it might be smaller.
1985
- * @type {number}
1986
- * @memberof OrdersApiGetOrders
1987
1329
  */
1988
1330
  readonly pageSize?: number
1989
1331
 
1990
1332
  /**
1991
1333
  * Search term to filter based on order reference, customer name and email
1992
- * @type {string}
1993
- * @memberof OrdersApiGetOrders
1994
1334
  */
1995
1335
  readonly search?: string
1996
1336
 
1997
1337
  /**
1998
1338
  * Specify fulfillment IDs to list
1999
- * @type {Array<string>}
2000
- * @memberof OrdersApiGetOrders
2001
1339
  */
2002
1340
  readonly ids?: Array<string>
2003
1341
 
2004
1342
  /**
2005
1343
  * Filter by fulfillment status
2006
- * @type {Array<Status>}
2007
- * @memberof OrdersApiGetOrders
2008
1344
  */
2009
1345
  readonly statuses?: Array<Status>
2010
1346
 
2011
1347
  /**
2012
1348
  * Start of date range
2013
- * @type {string}
2014
- * @memberof OrdersApiGetOrders
2015
1349
  */
2016
1350
  readonly start?: string
2017
1351
 
2018
1352
  /**
2019
1353
  * End of date range
2020
- * @type {string}
2021
- * @memberof OrdersApiGetOrders
2022
1354
  */
2023
1355
  readonly end?: string
2024
1356
 
2025
1357
  /**
2026
1358
  * Specifies the type of date range filter to apply. Determines which date field the &#x60;start&#x60; and &#x60;end&#x60; fields should query.
2027
- * @type {'createdAt' | 'updatedAt' | 'statusChangedAt'}
2028
- * @memberof OrdersApiGetOrders
2029
1359
  */
2030
1360
  readonly dateFilterType?: GetOrdersDateFilterTypeEnum
2031
1361
  }
2032
1362
 
2033
1363
  /**
2034
1364
  * Request parameters for retryPlatformPayment operation in OrdersApi.
2035
- * @export
2036
- * @interface OrdersApiRetryPlatformPaymentRequest
2037
1365
  */
2038
1366
  export interface OrdersApiRetryPlatformPaymentRequest {
2039
1367
  /**
2040
1368
  * What project it is
2041
- * @type {string}
2042
- * @memberof OrdersApiRetryPlatformPayment
2043
1369
  */
2044
1370
  readonly project: string
2045
1371
 
2046
1372
  /**
2047
1373
  * Unique identifier of an order
2048
- * @type {string}
2049
- * @memberof OrdersApiRetryPlatformPayment
2050
1374
  */
2051
1375
  readonly orderId: string
2052
1376
 
2053
1377
  /**
2054
1378
  * Specifies which fields to return, separated by commas
2055
- * @type {string}
2056
- * @memberof OrdersApiRetryPlatformPayment
2057
1379
  */
2058
1380
  readonly fields?: string
2059
1381
  }
2060
1382
 
2061
1383
  /**
2062
1384
  * OrdersApi - object-oriented interface
2063
- * @export
2064
- * @class OrdersApi
2065
- * @extends {BaseAPI}
2066
1385
  */
2067
1386
  export class OrdersApi extends BaseAPI {
2068
1387
  /**
@@ -2071,7 +1390,6 @@ export class OrdersApi extends BaseAPI {
2071
1390
  * @param {OrdersApiCancelOrderRequest} requestParameters Request parameters.
2072
1391
  * @param {*} [options] Override http request option.
2073
1392
  * @throws {RequiredError}
2074
- * @memberof OrdersApi
2075
1393
  */
2076
1394
  public cancelOrder(requestParameters: OrdersApiCancelOrderRequest, options?: RawAxiosRequestConfig) {
2077
1395
  return OrdersApiFp(this.configuration).cancelOrder(requestParameters.project, requestParameters.orderId, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
@@ -2083,7 +1401,6 @@ export class OrdersApi extends BaseAPI {
2083
1401
  * @param {OrdersApiConfirmOrderRequest} requestParameters Request parameters.
2084
1402
  * @param {*} [options] Override http request option.
2085
1403
  * @throws {RequiredError}
2086
- * @memberof OrdersApi
2087
1404
  */
2088
1405
  public confirmOrder(requestParameters: OrdersApiConfirmOrderRequest, options?: RawAxiosRequestConfig) {
2089
1406
  return OrdersApiFp(this.configuration).confirmOrder(requestParameters.project, requestParameters.orderId, requestParameters.confirmOrderRequest, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
@@ -2095,7 +1412,6 @@ export class OrdersApi extends BaseAPI {
2095
1412
  * @param {OrdersApiCreateOrderRequest} requestParameters Request parameters.
2096
1413
  * @param {*} [options] Override http request option.
2097
1414
  * @throws {RequiredError}
2098
- * @memberof OrdersApi
2099
1415
  */
2100
1416
  public createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: RawAxiosRequestConfig) {
2101
1417
  return OrdersApiFp(this.configuration).createOrder(requestParameters.project, requestParameters.createOrder, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
@@ -2107,7 +1423,6 @@ export class OrdersApi extends BaseAPI {
2107
1423
  * @param {OrdersApiDownloadInvoiceRequest} requestParameters Request parameters.
2108
1424
  * @param {*} [options] Override http request option.
2109
1425
  * @throws {RequiredError}
2110
- * @memberof OrdersApi
2111
1426
  */
2112
1427
  public downloadInvoice(requestParameters: OrdersApiDownloadInvoiceRequest, options?: RawAxiosRequestConfig) {
2113
1428
  return OrdersApiFp(this.configuration).downloadInvoice(requestParameters.project, requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
@@ -2119,7 +1434,6 @@ export class OrdersApi extends BaseAPI {
2119
1434
  * @param {OrdersApiExportOrdersRequest} requestParameters Request parameters.
2120
1435
  * @param {*} [options] Override http request option.
2121
1436
  * @throws {RequiredError}
2122
- * @memberof OrdersApi
2123
1437
  */
2124
1438
  public exportOrders(requestParameters: OrdersApiExportOrdersRequest, options?: RawAxiosRequestConfig) {
2125
1439
  return OrdersApiFp(this.configuration).exportOrders(requestParameters.project, requestParameters.start, requestParameters.end, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
@@ -2131,7 +1445,6 @@ export class OrdersApi extends BaseAPI {
2131
1445
  * @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
2132
1446
  * @param {*} [options] Override http request option.
2133
1447
  * @throws {RequiredError}
2134
- * @memberof OrdersApi
2135
1448
  */
2136
1449
  public getOrder(requestParameters: OrdersApiGetOrderRequest, options?: RawAxiosRequestConfig) {
2137
1450
  return OrdersApiFp(this.configuration).getOrder(requestParameters.project, requestParameters.orderId, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
@@ -2143,7 +1456,6 @@ export class OrdersApi extends BaseAPI {
2143
1456
  * @param {OrdersApiGetOrdersRequest} requestParameters Request parameters.
2144
1457
  * @param {*} [options] Override http request option.
2145
1458
  * @throws {RequiredError}
2146
- * @memberof OrdersApi
2147
1459
  */
2148
1460
  public getOrders(requestParameters: OrdersApiGetOrdersRequest, options?: RawAxiosRequestConfig) {
2149
1461
  return OrdersApiFp(this.configuration).getOrders(requestParameters.project, requestParameters.fields, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.ids, requestParameters.statuses, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, options).then((request) => request(this.axios, this.basePath));
@@ -2155,16 +1467,12 @@ export class OrdersApi extends BaseAPI {
2155
1467
  * @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
2156
1468
  * @param {*} [options] Override http request option.
2157
1469
  * @throws {RequiredError}
2158
- * @memberof OrdersApi
2159
1470
  */
2160
1471
  public retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig) {
2161
1472
  return OrdersApiFp(this.configuration).retryPlatformPayment(requestParameters.project, requestParameters.orderId, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
2162
1473
  }
2163
1474
  }
2164
1475
 
2165
- /**
2166
- * @export
2167
- */
2168
1476
  export const GetOrdersDateFilterTypeEnum = {
2169
1477
  CreatedAt: 'createdAt',
2170
1478
  UpdatedAt: 'updatedAt',