@teemill/orders 1.20.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/dist/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Orders API
3
3
  * 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.
4
4
  *
5
- * The version of the OpenAPI document: 1.20.0
5
+ * The version of the OpenAPI document: 1.22.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -15,146 +15,74 @@ import type { RequestArgs } from './base';
15
15
  import { BaseAPI } from './base';
16
16
  /**
17
17
  * A person\'s address.
18
- * @export
19
- * @interface Address
20
18
  */
21
19
  export interface Address {
22
- /**
23
- *
24
- * @type {string}
25
- * @memberof Address
26
- */
27
20
  'contactName'?: string;
28
- /**
29
- *
30
- * @type {string}
31
- * @memberof Address
32
- */
33
21
  'company'?: string;
34
22
  /**
35
23
  * First line of the address.
36
- * @type {string}
37
- * @memberof Address
38
24
  */
39
25
  'line1'?: string;
40
26
  /**
41
27
  * Second line of the address.
42
- * @type {string}
43
- * @memberof Address
44
28
  */
45
29
  'line2'?: string;
46
30
  /**
47
31
  * City of the address.
48
- * @type {string}
49
- * @memberof Address
50
32
  */
51
33
  'city'?: string;
52
34
  /**
53
35
  * Postal code of the address.
54
- * @type {string}
55
- * @memberof Address
56
36
  */
57
37
  'postalCode'?: string;
58
38
  /**
59
39
  * Country of the address (ISO 3166-1 alpha-2).
60
- * @type {string}
61
- * @memberof Address
62
40
  */
63
41
  'country': string;
64
42
  /**
65
43
  * State of the address. If the country is Canada, Australia, or the United States, this field is required.
66
- * @type {string}
67
- * @memberof Address
68
44
  */
69
45
  'state'?: string;
70
46
  }
71
- /**
72
- *
73
- * @export
74
- * @interface ApiError
75
- */
76
47
  export interface ApiError {
77
- /**
78
- *
79
- * @type {string}
80
- * @memberof ApiError
81
- */
82
48
  'code'?: string;
83
- /**
84
- *
85
- * @type {string}
86
- * @memberof ApiError
87
- */
88
49
  'message': string;
89
50
  }
90
51
  /**
91
- *
92
- * @export
93
- * @interface ConfirmOrderFulfillment
52
+ * @type ConfirmOrderFulfillment
94
53
  */
95
- export interface ConfirmOrderFulfillment {
54
+ export type ConfirmOrderFulfillment = ConfirmOrderFulfillmentWithShipment | ConfirmOrderFulfillmentWithShippingMethod;
55
+ export interface ConfirmOrderFulfillmentWithShipment {
96
56
  /**
97
57
  * Unique object identifier
98
- * @type {string}
99
- * @memberof ConfirmOrderFulfillment
100
58
  */
101
59
  'fulfillmentId': string;
102
- /**
103
- * Unique object identifier
104
- * @type {string}
105
- * @memberof ConfirmOrderFulfillment
106
- */
107
- 'shippingMethodId'?: string;
108
- /**
109
- *
110
- * @type {ConfirmOrderFulfillmentShipment}
111
- * @memberof ConfirmOrderFulfillment
112
- */
113
- 'shipment'?: ConfirmOrderFulfillmentShipment;
60
+ 'shipment': ConfirmOrderFulfillmentWithShipmentShipment;
114
61
  }
115
62
  /**
116
63
  * This field is only required if you are using your own shipping label.
117
- * @export
118
- * @interface ConfirmOrderFulfillmentShipment
119
64
  */
120
- export interface ConfirmOrderFulfillmentShipment {
65
+ export interface ConfirmOrderFulfillmentWithShipmentShipment {
121
66
  /**
122
67
  * Only required if you are generating shipping labels outside of PodOS
123
- * @type {string}
124
- * @memberof ConfirmOrderFulfillmentShipment
125
68
  */
126
69
  'image': string;
127
70
  }
128
- /**
129
- *
130
- * @export
131
- * @interface ConfirmOrderRequest
132
- */
133
- export interface ConfirmOrderRequest {
71
+ export interface ConfirmOrderFulfillmentWithShippingMethod {
134
72
  /**
135
- *
136
- * @type {Array<ConfirmOrderFulfillment>}
137
- * @memberof ConfirmOrderRequest
73
+ * Unique object identifier
138
74
  */
75
+ 'fulfillmentId': string;
76
+ /**
77
+ * Unique object identifier
78
+ */
79
+ 'shippingMethodId': string;
80
+ }
81
+ export interface ConfirmOrderRequest {
139
82
  'fulfillments': Array<ConfirmOrderFulfillment>;
140
83
  }
141
- /**
142
- *
143
- * @export
144
- * @interface ConfirmOrderValidationError
145
- */
146
84
  export interface ConfirmOrderValidationError {
147
- /**
148
- *
149
- * @type {string}
150
- * @memberof ConfirmOrderValidationError
151
- */
152
85
  'code': ConfirmOrderValidationErrorCodeEnum;
153
- /**
154
- *
155
- * @type {string}
156
- * @memberof ConfirmOrderValidationError
157
- */
158
86
  'message': string;
159
87
  }
160
88
  export declare const ConfirmOrderValidationErrorCodeEnum: {
@@ -166,138 +94,67 @@ export declare const ConfirmOrderValidationErrorCodeEnum: {
166
94
  export type ConfirmOrderValidationErrorCodeEnum = typeof ConfirmOrderValidationErrorCodeEnum[keyof typeof ConfirmOrderValidationErrorCodeEnum];
167
95
  /**
168
96
  * Order recipient contact information, used only for courier tracking/updates.
169
- * @export
170
- * @interface ContactInformation
171
97
  */
172
98
  export interface ContactInformation {
173
- /**
174
- *
175
- * @type {string}
176
- * @memberof ContactInformation
177
- */
178
99
  'email': string;
179
- /**
180
- *
181
- * @type {string}
182
- * @memberof ContactInformation
183
- */
184
100
  'phone'?: string | null;
185
101
  }
186
102
  /**
187
103
  * Coupon applied to the order.
188
- * @export
189
- * @interface Coupon
190
104
  */
191
105
  export interface Coupon {
192
106
  /**
193
107
  * Unique object identifier
194
- * @type {string}
195
- * @memberof Coupon
196
108
  */
197
109
  'id': string;
198
- /**
199
- *
200
- * @type {string}
201
- * @memberof Coupon
202
- */
203
110
  'code': string;
204
111
  /**
205
112
  * Reference to the discount. **Note:** Requires the discounts integration to see the reference.
206
- * @type {string}
207
- * @memberof Coupon
208
113
  */
209
114
  'ref'?: string | null;
210
115
  }
211
116
  /**
212
117
  * Create an order
213
- * @export
214
- * @interface CreateOrder
215
118
  */
216
119
  export interface CreateOrder {
217
120
  /**
218
121
  * A custom reference to the merchant\'s order.
219
- * @type {string}
220
- * @memberof CreateOrder
221
122
  */
222
123
  'merchantReference'?: string | null;
223
- /**
224
- *
225
- * @type {CreateOrderContactInformation}
226
- * @memberof CreateOrder
227
- */
228
124
  'contactInformation': CreateOrderContactInformation;
229
- /**
230
- *
231
- * @type {Address}
232
- * @memberof CreateOrder
233
- */
234
125
  'shippingAddress': Address;
235
- /**
236
- *
237
- * @type {CustomsInformation}
238
- * @memberof CreateOrder
239
- */
240
126
  'customsInformation'?: CustomsInformation;
241
127
  /**
242
128
  * Items to be ordered
243
- * @type {Array<OrderItem1>}
244
- * @memberof CreateOrder
245
129
  */
246
130
  'items': Array<OrderItem1>;
247
- /**
248
- *
249
- * @type {Array<string>}
250
- * @memberof CreateOrder
251
- */
252
131
  'preferredFulfillers'?: Array<string>;
253
132
  }
254
133
  /**
255
134
  * Contact information for the order
256
- * @export
257
- * @interface CreateOrderContactInformation
258
135
  */
259
136
  export interface CreateOrderContactInformation {
260
- /**
261
- *
262
- * @type {string}
263
- * @memberof CreateOrderContactInformation
264
- */
265
137
  'email': string;
266
- /**
267
- *
268
- * @type {string}
269
- * @memberof CreateOrderContactInformation
270
- */
271
138
  'phone'?: string | null;
272
139
  }
273
140
  /**
274
141
  * Customs information for the order. **Note:** Adding customs information to an order is only compatible with Shipmate at this time
275
- * @export
276
- * @interface CustomsInformation
277
142
  */
278
143
  export interface CustomsInformation {
279
144
  /**
280
145
  * Pre-registration type
281
- * @type {string}
282
- * @memberof CustomsInformation
283
146
  */
284
147
  'preRegistrationType'?: CustomsInformationPreRegistrationTypeEnum;
285
148
  /**
286
149
  * Pre-registration number
287
- * @type {string}
288
- * @memberof CustomsInformation
289
150
  */
290
151
  'preRegistrationNumber'?: string;
291
152
  /**
292
153
  * VAT number
293
- * @type {string}
294
- * @memberof CustomsInformation
295
154
  */
296
155
  'vatNumber'?: string;
297
156
  /**
298
157
  * EORI number
299
- * @type {string}
300
- * @memberof CustomsInformation
301
158
  */
302
159
  'eoriNumber'?: string;
303
160
  }
@@ -305,590 +162,218 @@ export declare const CustomsInformationPreRegistrationTypeEnum: {
305
162
  readonly Ioss: "IOSS";
306
163
  };
307
164
  export type CustomsInformationPreRegistrationTypeEnum = typeof CustomsInformationPreRegistrationTypeEnum[keyof typeof CustomsInformationPreRegistrationTypeEnum];
308
- /**
309
- *
310
- * @export
311
- * @interface CustomsInformation1
312
- */
313
165
  export interface CustomsInformation1 {
314
- /**
315
- *
316
- * @type {string}
317
- * @memberof CustomsInformation1
318
- */
319
166
  'preRegistrationType'?: string;
320
- /**
321
- *
322
- * @type {string}
323
- * @memberof CustomsInformation1
324
- */
325
167
  'preRegistrationNumber'?: string;
326
- /**
327
- *
328
- * @type {string}
329
- * @memberof CustomsInformation1
330
- */
331
168
  'vatNumber'?: string;
332
- /**
333
- *
334
- * @type {string}
335
- * @memberof CustomsInformation1
336
- */
337
169
  'eoriNumber'?: string;
338
170
  }
339
- /**
340
- *
341
- * @export
342
- * @interface DeliveryEstimates
343
- */
344
171
  export interface DeliveryEstimates {
345
172
  /**
346
173
  * 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.
347
- * @type {boolean}
348
- * @memberof DeliveryEstimates
349
174
  */
350
175
  'isPriority'?: boolean;
351
176
  /**
352
177
  * ISO 8601 Timestamp
353
- * @type {string}
354
- * @memberof DeliveryEstimates
355
178
  */
356
179
  'min'?: string;
357
180
  /**
358
181
  * ISO 8601 Timestamp
359
- * @type {string}
360
- * @memberof DeliveryEstimates
361
182
  */
362
183
  'max'?: string;
363
184
  }
364
- /**
365
- *
366
- * @export
367
- * @interface ExportOrders202Response
368
- */
369
185
  export interface ExportOrders202Response {
370
186
  /**
371
187
  * A message describing the export status
372
- * @type {string}
373
- * @memberof ExportOrders202Response
374
188
  */
375
189
  'message'?: string;
376
190
  }
377
- /**
378
- *
379
- * @export
380
- * @interface Fulfillment
381
- */
382
191
  export interface Fulfillment {
383
192
  /**
384
193
  * Unique fulfillment id
385
- * @type {string}
386
- * @memberof Fulfillment
387
194
  */
388
195
  'id'?: string;
389
- /**
390
- *
391
- * @type {Status}
392
- * @memberof Fulfillment
393
- */
394
196
  'status'?: Status;
395
- /**
396
- *
397
- * @type {FulfillmentFulfiller}
398
- * @memberof Fulfillment
399
- */
400
197
  'fulfiller'?: FulfillmentFulfiller;
401
- /**
402
- *
403
- * @type {Array<FulfillmentItem>}
404
- * @memberof Fulfillment
405
- */
406
198
  'items'?: Array<FulfillmentItem>;
407
- /**
408
- *
409
- * @type {OrderTracking}
410
- * @memberof Fulfillment
411
- */
412
199
  'tracking'?: OrderTracking | null;
413
200
  /**
414
201
  * Shipping method currently set
415
- * @type {ShippingMethod}
416
- * @memberof Fulfillment
417
202
  */
418
203
  'shippingMethod'?: ShippingMethod;
419
204
  /**
420
205
  * Shipping methods available for this fulfillment. One of these should be used to confirm the fulfillment.
421
- * @type {Array<ShippingMethod>}
422
- * @memberof Fulfillment
423
206
  */
424
207
  'availableShippingMethods'?: Array<ShippingMethod>;
425
208
  /**
426
209
  * Weight of the package being shipped in grams
427
- * @type {number}
428
- * @memberof Fulfillment
429
210
  */
430
211
  'packageWeight'?: number;
431
212
  }
432
213
  /**
433
214
  * The fulfiller that will be processing this order.
434
- * @export
435
- * @interface FulfillmentFulfiller
436
215
  */
437
216
  export interface FulfillmentFulfiller {
438
217
  /**
439
218
  * Unique object identifier
440
- * @type {string}
441
- * @memberof FulfillmentFulfiller
442
219
  */
443
220
  'id'?: string;
444
- /**
445
- *
446
- * @type {FulfillmentFulfillerLocation}
447
- * @memberof FulfillmentFulfiller
448
- */
449
221
  'location'?: FulfillmentFulfillerLocation;
450
222
  }
451
- /**
452
- *
453
- * @export
454
- * @interface FulfillmentFulfillerLocation
455
- */
456
223
  export interface FulfillmentFulfillerLocation {
457
- /**
458
- *
459
- * @type {string}
460
- * @memberof FulfillmentFulfillerLocation
461
- */
462
224
  'city'?: string | null;
463
- /**
464
- *
465
- * @type {string}
466
- * @memberof FulfillmentFulfillerLocation
467
- */
468
225
  'country'?: string | null;
469
226
  }
470
- /**
471
- *
472
- * @export
473
- * @interface FulfillmentItem
474
- */
475
227
  export interface FulfillmentItem {
476
228
  /**
477
229
  * Unique fulfillment item id
478
- * @type {string}
479
- * @memberof FulfillmentItem
480
230
  */
481
231
  'id'?: string;
482
232
  /**
483
233
  * Id of the order item being fulfilled
484
- * @type {string}
485
- * @memberof FulfillmentItem
486
234
  */
487
235
  'itemId'?: string;
488
236
  /**
489
237
  * Number of this item being fulfilled
490
- * @type {number}
491
- * @memberof FulfillmentItem
492
238
  */
493
239
  'quantity'?: number;
494
240
  }
495
241
  /**
496
242
  * Image description
497
- * @export
498
- * @interface Image
499
243
  */
500
244
  export interface Image {
501
245
  /**
502
246
  * Unique object identifier
503
- * @type {string}
504
- * @memberof Image
505
247
  */
506
248
  'id'?: string;
507
- /**
508
- *
509
- * @type {string}
510
- * @memberof Image
511
- */
512
249
  'src'?: string;
513
- /**
514
- *
515
- * @type {string}
516
- * @memberof Image
517
- */
518
250
  'alt'?: string;
519
- /**
520
- *
521
- * @type {number}
522
- * @memberof Image
523
- */
524
251
  'sortOrder'?: number;
525
252
  }
526
- /**
527
- *
528
- * @export
529
- * @interface Option
530
- */
531
253
  export interface Option {
532
254
  /**
533
255
  * Option name
534
- * @type {string}
535
- * @memberof Option
536
256
  */
537
257
  'name': string;
538
258
  /**
539
259
  * Option value
540
- * @type {string}
541
- * @memberof Option
542
260
  */
543
261
  'value': string;
544
262
  }
545
- /**
546
- *
547
- * @export
548
- * @interface Order
549
- */
550
263
  export interface Order {
551
264
  /**
552
265
  * Unique object identifier
553
- * @type {string}
554
- * @memberof Order
555
266
  */
556
267
  'id'?: string;
557
268
  /**
558
269
  * A reference to the resource location
559
- * @type {string}
560
- * @memberof Order
561
270
  */
562
271
  'ref'?: string;
563
- /**
564
- *
565
- * @type {Status}
566
- * @memberof Order
567
- */
568
272
  'status'?: Status;
569
- /**
570
- *
571
- * @type {ContactInformation}
572
- * @memberof Order
573
- */
574
273
  'contactInformation': ContactInformation;
575
- /**
576
- *
577
- * @type {Address}
578
- * @memberof Order
579
- */
274
+ 'paymentMethod'?: PaymentMethod;
580
275
  'shippingAddress': Address;
581
- /**
582
- *
583
- * @type {CustomsInformation1}
584
- * @memberof Order
585
- */
586
276
  'customsInformation'?: CustomsInformation1;
587
277
  /**
588
278
  * ISO 8601 Timestamp
589
- * @type {string}
590
- * @memberof Order
591
279
  */
592
280
  'createdAt'?: string;
593
281
  /**
594
282
  * ISO 8601 Timestamp
595
- * @type {string}
596
- * @memberof Order
597
283
  */
598
284
  'updatedAt'?: string;
599
285
  /**
600
286
  * ISO 8601 Timestamp
601
- * @type {string}
602
- * @memberof Order
603
287
  */
604
288
  'statusChangedAt'?: string;
605
289
  /**
606
290
  * A custom reference to the merchant\'s order.
607
- * @type {string}
608
- * @memberof Order
609
291
  */
610
292
  'merchantReference'?: string | null;
611
- /**
612
- *
613
- * @type {Array<Fulfillment>}
614
- * @memberof Order
615
- */
616
293
  'fulfillments'?: Array<Fulfillment>;
617
- /**
618
- *
619
- * @type {Array<OrderItem>}
620
- * @memberof Order
621
- */
622
294
  'items': Array<OrderItem>;
623
- /**
624
- *
625
- * @type {Price}
626
- * @memberof Order
627
- */
628
295
  'totalPrice'?: Price;
629
- /**
630
- *
631
- * @type {Price}
632
- * @memberof Order
633
- */
634
296
  'taxPrice'?: Price;
635
- /**
636
- *
637
- * @type {Price}
638
- * @memberof Order
639
- */
640
297
  'subtotalPrice'?: Price;
641
- /**
642
- *
643
- * @type {Price}
644
- * @memberof Order
645
- */
646
298
  'discountPrice'?: Price;
647
- /**
648
- *
649
- * @type {Coupon}
650
- * @memberof Order
651
- */
652
299
  'coupon'?: Coupon | null;
653
- /**
654
- *
655
- * @type {Price}
656
- * @memberof Order
657
- */
658
300
  'shippingPrice'?: Price;
659
- /**
660
- *
661
- * @type {Origin}
662
- * @memberof Order
663
- */
664
301
  'origin'?: Origin;
665
- /**
666
- *
667
- * @type {Array<StatusHistoryItem>}
668
- * @memberof Order
669
- */
670
302
  'statusHistory'?: Array<StatusHistoryItem>;
671
- /**
672
- *
673
- * @type {Array<PaymentAttempt>}
674
- * @memberof Order
675
- */
676
303
  'paymentAttempts'?: Array<PaymentAttempt>;
677
304
  }
678
- /**
679
- *
680
- * @export
681
- * @interface OrderItem
682
- */
683
305
  export interface OrderItem {
684
306
  /**
685
307
  * Unique object identifier
686
- * @type {string}
687
- * @memberof OrderItem
688
308
  */
689
309
  'id'?: string;
690
310
  /**
691
311
  * A reference to the variant being ordered
692
- * @type {string}
693
- * @memberof OrderItem
694
312
  */
695
313
  'variantRef': string;
696
314
  /**
697
315
  * Options associated to an order item\'s variant, such as color and size.
698
- * @type {Array<Option>}
699
- * @memberof OrderItem
700
316
  */
701
317
  'options'?: Array<Option>;
702
- /**
703
- *
704
- * @type {number}
705
- * @memberof OrderItem
706
- */
707
318
  'quantity': number;
708
319
  /**
709
320
  * The name of the product
710
- * @type {string}
711
- * @memberof OrderItem
712
321
  */
713
322
  'name'?: string;
714
323
  /**
715
324
  * Images
716
- * @type {Array<Image>}
717
- * @memberof OrderItem
718
325
  */
719
326
  'images'?: Array<Image>;
720
- /**
721
- *
722
- * @type {Price}
723
- * @memberof OrderItem
724
- */
725
327
  'totalPrice'?: Price;
726
328
  /**
727
329
  * This is an estimate until the order has been confirmed
728
- * @type {Price}
729
- * @memberof OrderItem
730
330
  */
731
331
  'taxPrice'?: Price;
732
- /**
733
- *
734
- * @type {Price}
735
- * @memberof OrderItem
736
- */
737
332
  'subtotalPrice'?: Price;
738
- /**
739
- *
740
- * @type {Price}
741
- * @memberof OrderItem
742
- */
743
333
  'discountPrice'?: Price;
744
334
  /**
745
335
  * The price you charged the recipient for each item. It\'s highly recommended if you have international orders as it aids customs issues.
746
- * @type {Price}
747
- * @memberof OrderItem
748
336
  */
749
337
  'recipientCost'?: Price;
750
338
  }
751
- /**
752
- *
753
- * @export
754
- * @interface OrderItem1
755
- */
756
339
  export interface OrderItem1 {
757
340
  /**
758
341
  * A reference to the variant being ordered
759
- * @type {string}
760
- * @memberof OrderItem1
761
342
  */
762
343
  'variantRef': string;
763
- /**
764
- *
765
- * @type {number}
766
- * @memberof OrderItem1
767
- */
768
344
  'quantity': number;
769
- /**
770
- *
771
- * @type {OrderItem1RecipientCost}
772
- * @memberof OrderItem1
773
- */
774
345
  'recipientCost'?: OrderItem1RecipientCost;
775
346
  }
776
- /**
777
- *
778
- * @export
779
- * @interface OrderItem1RecipientCost
780
- */
781
347
  export interface OrderItem1RecipientCost {
782
- /**
783
- *
784
- * @type {string}
785
- * @memberof OrderItem1RecipientCost
786
- */
787
348
  'amount': string;
788
- /**
789
- *
790
- * @type {string}
791
- * @memberof OrderItem1RecipientCost
792
- */
793
349
  'currencyCode': string;
794
350
  }
795
- /**
796
- *
797
- * @export
798
- * @interface OrderTracking
799
- */
800
351
  export interface OrderTracking {
801
- /**
802
- *
803
- * @type {string}
804
- * @memberof OrderTracking
805
- */
806
352
  'courier'?: string;
807
- /**
808
- *
809
- * @type {string}
810
- * @memberof OrderTracking
811
- */
812
353
  'code'?: string;
813
- /**
814
- *
815
- * @type {string}
816
- * @memberof OrderTracking
817
- */
818
354
  'url'?: string;
819
355
  }
820
- /**
821
- *
822
- * @export
823
- * @interface OrdersResponse
824
- */
825
356
  export interface OrdersResponse {
826
- /**
827
- *
828
- * @type {Array<Order>}
829
- * @memberof OrdersResponse
830
- */
831
357
  'orders'?: Array<Order>;
832
358
  /**
833
359
  * The token referencing the next page number
834
- * @type {number}
835
- * @memberof OrdersResponse
836
360
  */
837
361
  'nextPageToken'?: number | null;
838
362
  }
839
- /**
840
- *
841
- * @export
842
- * @interface Origin
843
- */
844
363
  export interface Origin {
845
- /**
846
- *
847
- * @type {string}
848
- * @memberof Origin
849
- */
850
364
  'code'?: string;
851
- /**
852
- *
853
- * @type {boolean}
854
- * @memberof Origin
855
- */
856
365
  'isPaid'?: boolean;
857
366
  }
858
367
  /**
859
368
  * List of payment attempts for this order
860
- * @export
861
- * @interface PaymentAttempt
862
369
  */
863
370
  export interface PaymentAttempt {
864
- /**
865
- *
866
- * @type {string}
867
- * @memberof PaymentAttempt
868
- */
869
371
  'paymentProvider'?: PaymentAttemptPaymentProviderEnum;
870
- /**
871
- *
872
- * @type {string}
873
- * @memberof PaymentAttempt
874
- */
875
372
  'status'?: PaymentAttemptStatusEnum;
876
- /**
877
- *
878
- * @type {string}
879
- * @memberof PaymentAttempt
880
- */
881
373
  'transactionId'?: string | null;
882
- /**
883
- *
884
- * @type {string}
885
- * @memberof PaymentAttempt
886
- */
887
374
  'message'?: string;
888
375
  /**
889
376
  * ISO 8601 Timestamp
890
- * @type {string}
891
- * @memberof PaymentAttempt
892
377
  */
893
378
  'createdAt'?: string;
894
379
  }
@@ -905,85 +390,35 @@ export declare const PaymentAttemptStatusEnum: {
905
390
  readonly Cancelled: "cancelled";
906
391
  };
907
392
  export type PaymentAttemptStatusEnum = typeof PaymentAttemptStatusEnum[keyof typeof PaymentAttemptStatusEnum];
393
+ export interface PaymentMethod {
394
+ 'type'?: string;
395
+ }
908
396
  /**
909
397
  * Standard price definition that defines the amount and currency.
910
- * @export
911
- * @interface Price
912
398
  */
913
399
  export interface Price {
914
400
  /**
915
401
  * Price including tax in the specified currency.
916
- * @type {string}
917
- * @memberof Price
918
402
  */
919
403
  'amount'?: string;
920
404
  /**
921
405
  * Currency code for the currency the price is valued in.
922
- * @type {string}
923
- * @memberof Price
924
406
  */
925
407
  'currencyCode'?: string;
926
408
  }
927
- /**
928
- *
929
- * @export
930
- * @interface ShippingMethod
931
- */
932
409
  export interface ShippingMethod {
933
410
  /**
934
411
  * Unique object identifier
935
- * @type {string}
936
- * @memberof ShippingMethod
937
412
  */
938
413
  'id'?: string;
939
- /**
940
- *
941
- * @type {string}
942
- * @memberof ShippingMethod
943
- */
944
414
  'name'?: string;
945
- /**
946
- *
947
- * @type {string}
948
- * @memberof ShippingMethod
949
- */
950
415
  'description'?: string;
951
- /**
952
- *
953
- * @type {DeliveryEstimates}
954
- * @memberof ShippingMethod
955
- */
956
416
  'deliveryEstimates'?: DeliveryEstimates;
957
- /**
958
- *
959
- * @type {Price}
960
- * @memberof ShippingMethod
961
- */
962
417
  'totalPrice'?: Price;
963
- /**
964
- *
965
- * @type {Price}
966
- * @memberof ShippingMethod
967
- */
968
418
  'taxPrice'?: Price;
969
- /**
970
- *
971
- * @type {Price}
972
- * @memberof ShippingMethod
973
- */
974
419
  'subtotalPrice'?: Price;
975
- /**
976
- *
977
- * @type {Price}
978
- * @memberof ShippingMethod
979
- */
980
420
  'discountPrice'?: Price;
981
421
  }
982
- /**
983
- *
984
- * @export
985
- * @enum {string}
986
- */
987
422
  export declare const Status: {
988
423
  readonly New: "new";
989
424
  readonly Paid: "paid";
@@ -993,28 +428,15 @@ export declare const Status: {
993
428
  readonly Quote: "quote";
994
429
  };
995
430
  export type Status = typeof Status[keyof typeof Status];
996
- /**
997
- *
998
- * @export
999
- * @interface StatusHistoryItem
1000
- */
1001
431
  export interface StatusHistoryItem {
1002
- /**
1003
- *
1004
- * @type {Status}
1005
- * @memberof StatusHistoryItem
1006
- */
1007
432
  'status'?: Status;
1008
433
  /**
1009
434
  * ISO 8601 Timestamp
1010
- * @type {string}
1011
- * @memberof StatusHistoryItem
1012
435
  */
1013
436
  'createdAt'?: string;
1014
437
  }
1015
438
  /**
1016
439
  * OrdersApi - axios parameter creator
1017
- * @export
1018
440
  */
1019
441
  export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration) => {
1020
442
  /**
@@ -1108,7 +530,6 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
1108
530
  };
1109
531
  /**
1110
532
  * OrdersApi - functional programming interface
1111
- * @export
1112
533
  */
1113
534
  export declare const OrdersApiFp: (configuration?: Configuration) => {
1114
535
  /**
@@ -1202,7 +623,6 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
1202
623
  };
1203
624
  /**
1204
625
  * OrdersApi - factory interface
1205
- * @export
1206
626
  */
1207
627
  export declare const OrdersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1208
628
  /**
@@ -1272,257 +692,174 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
1272
692
  };
1273
693
  /**
1274
694
  * Request parameters for cancelOrder operation in OrdersApi.
1275
- * @export
1276
- * @interface OrdersApiCancelOrderRequest
1277
695
  */
1278
696
  export interface OrdersApiCancelOrderRequest {
1279
697
  /**
1280
698
  * What project it is
1281
- * @type {string}
1282
- * @memberof OrdersApiCancelOrder
1283
699
  */
1284
700
  readonly project: string;
1285
701
  /**
1286
702
  * Unique identifier of an order
1287
- * @type {string}
1288
- * @memberof OrdersApiCancelOrder
1289
703
  */
1290
704
  readonly orderId: string;
1291
705
  /**
1292
706
  * Specifies which fields to return, separated by commas
1293
- * @type {string}
1294
- * @memberof OrdersApiCancelOrder
1295
707
  */
1296
708
  readonly fields?: string;
1297
709
  }
1298
710
  /**
1299
711
  * Request parameters for confirmOrder operation in OrdersApi.
1300
- * @export
1301
- * @interface OrdersApiConfirmOrderRequest
1302
712
  */
1303
713
  export interface OrdersApiConfirmOrderRequest {
1304
714
  /**
1305
715
  * What project it is
1306
- * @type {string}
1307
- * @memberof OrdersApiConfirmOrder
1308
716
  */
1309
717
  readonly project: string;
1310
718
  /**
1311
719
  * Unique identifier of an order
1312
- * @type {string}
1313
- * @memberof OrdersApiConfirmOrder
1314
720
  */
1315
721
  readonly orderId: string;
1316
722
  /**
1317
723
  * ConfirmFulfillment schema
1318
- * @type {ConfirmOrderRequest}
1319
- * @memberof OrdersApiConfirmOrder
1320
724
  */
1321
725
  readonly confirmOrderRequest: ConfirmOrderRequest;
1322
726
  /**
1323
727
  * Specifies which fields to return, separated by commas
1324
- * @type {string}
1325
- * @memberof OrdersApiConfirmOrder
1326
728
  */
1327
729
  readonly fields?: string;
1328
730
  }
1329
731
  /**
1330
732
  * Request parameters for createOrder operation in OrdersApi.
1331
- * @export
1332
- * @interface OrdersApiCreateOrderRequest
1333
733
  */
1334
734
  export interface OrdersApiCreateOrderRequest {
1335
735
  /**
1336
736
  * What project it is
1337
- * @type {string}
1338
- * @memberof OrdersApiCreateOrder
1339
737
  */
1340
738
  readonly project: string;
1341
739
  /**
1342
740
  * Create Order schema
1343
- * @type {CreateOrder}
1344
- * @memberof OrdersApiCreateOrder
1345
741
  */
1346
742
  readonly createOrder: CreateOrder;
1347
743
  /**
1348
744
  * Specifies which fields to return, separated by commas
1349
- * @type {string}
1350
- * @memberof OrdersApiCreateOrder
1351
745
  */
1352
746
  readonly fields?: string;
1353
747
  }
1354
748
  /**
1355
749
  * Request parameters for downloadInvoice operation in OrdersApi.
1356
- * @export
1357
- * @interface OrdersApiDownloadInvoiceRequest
1358
750
  */
1359
751
  export interface OrdersApiDownloadInvoiceRequest {
1360
752
  /**
1361
753
  * What project it is
1362
- * @type {string}
1363
- * @memberof OrdersApiDownloadInvoice
1364
754
  */
1365
755
  readonly project: string;
1366
756
  /**
1367
757
  * Unique identifier of an order
1368
- * @type {string}
1369
- * @memberof OrdersApiDownloadInvoice
1370
758
  */
1371
759
  readonly orderId: string;
1372
760
  }
1373
761
  /**
1374
762
  * Request parameters for exportOrders operation in OrdersApi.
1375
- * @export
1376
- * @interface OrdersApiExportOrdersRequest
1377
763
  */
1378
764
  export interface OrdersApiExportOrdersRequest {
1379
765
  /**
1380
766
  * What project it is
1381
- * @type {string}
1382
- * @memberof OrdersApiExportOrders
1383
767
  */
1384
768
  readonly project: string;
1385
769
  /**
1386
770
  * Start of date range to filter by when orders were placed
1387
- * @type {string}
1388
- * @memberof OrdersApiExportOrders
1389
771
  */
1390
772
  readonly start: string;
1391
773
  /**
1392
774
  * End of date range
1393
- * @type {string}
1394
- * @memberof OrdersApiExportOrders
1395
775
  */
1396
776
  readonly end?: string;
1397
777
  /**
1398
778
  * Search term to filter based on order reference, customer name and email
1399
- * @type {string}
1400
- * @memberof OrdersApiExportOrders
1401
779
  */
1402
780
  readonly search?: string;
1403
781
  }
1404
782
  /**
1405
783
  * Request parameters for getOrder operation in OrdersApi.
1406
- * @export
1407
- * @interface OrdersApiGetOrderRequest
1408
784
  */
1409
785
  export interface OrdersApiGetOrderRequest {
1410
786
  /**
1411
787
  * What project it is
1412
- * @type {string}
1413
- * @memberof OrdersApiGetOrder
1414
788
  */
1415
789
  readonly project: string;
1416
790
  /**
1417
791
  * Unique identifier of an order
1418
- * @type {string}
1419
- * @memberof OrdersApiGetOrder
1420
792
  */
1421
793
  readonly orderId: string;
1422
794
  /**
1423
795
  * Specifies which fields to return, separated by commas
1424
- * @type {string}
1425
- * @memberof OrdersApiGetOrder
1426
796
  */
1427
797
  readonly fields?: string;
1428
798
  }
1429
799
  /**
1430
800
  * Request parameters for getOrders operation in OrdersApi.
1431
- * @export
1432
- * @interface OrdersApiGetOrdersRequest
1433
801
  */
1434
802
  export interface OrdersApiGetOrdersRequest {
1435
803
  /**
1436
804
  * What project it is
1437
- * @type {string}
1438
- * @memberof OrdersApiGetOrders
1439
805
  */
1440
806
  readonly project: string;
1441
807
  /**
1442
808
  * Specifies which fields to return, separated by commas
1443
- * @type {string}
1444
- * @memberof OrdersApiGetOrders
1445
809
  */
1446
810
  readonly fields?: string;
1447
811
  /**
1448
812
  * Page reference token
1449
- * @type {number}
1450
- * @memberof OrdersApiGetOrders
1451
813
  */
1452
814
  readonly pageToken?: number;
1453
815
  /**
1454
816
  * Max page size. This is the maximum page size that will be returned, but it might be smaller.
1455
- * @type {number}
1456
- * @memberof OrdersApiGetOrders
1457
817
  */
1458
818
  readonly pageSize?: number;
1459
819
  /**
1460
820
  * Search term to filter based on order reference, customer name and email
1461
- * @type {string}
1462
- * @memberof OrdersApiGetOrders
1463
821
  */
1464
822
  readonly search?: string;
1465
823
  /**
1466
824
  * Specify fulfillment IDs to list
1467
- * @type {Array<string>}
1468
- * @memberof OrdersApiGetOrders
1469
825
  */
1470
826
  readonly ids?: Array<string>;
1471
827
  /**
1472
828
  * Filter by fulfillment status
1473
- * @type {Array<Status>}
1474
- * @memberof OrdersApiGetOrders
1475
829
  */
1476
830
  readonly statuses?: Array<Status>;
1477
831
  /**
1478
832
  * Start of date range
1479
- * @type {string}
1480
- * @memberof OrdersApiGetOrders
1481
833
  */
1482
834
  readonly start?: string;
1483
835
  /**
1484
836
  * End of date range
1485
- * @type {string}
1486
- * @memberof OrdersApiGetOrders
1487
837
  */
1488
838
  readonly end?: string;
1489
839
  /**
1490
840
  * Specifies the type of date range filter to apply. Determines which date field the &#x60;start&#x60; and &#x60;end&#x60; fields should query.
1491
- * @type {'createdAt' | 'updatedAt' | 'statusChangedAt'}
1492
- * @memberof OrdersApiGetOrders
1493
841
  */
1494
842
  readonly dateFilterType?: GetOrdersDateFilterTypeEnum;
1495
843
  }
1496
844
  /**
1497
845
  * Request parameters for retryPlatformPayment operation in OrdersApi.
1498
- * @export
1499
- * @interface OrdersApiRetryPlatformPaymentRequest
1500
846
  */
1501
847
  export interface OrdersApiRetryPlatformPaymentRequest {
1502
848
  /**
1503
849
  * What project it is
1504
- * @type {string}
1505
- * @memberof OrdersApiRetryPlatformPayment
1506
850
  */
1507
851
  readonly project: string;
1508
852
  /**
1509
853
  * Unique identifier of an order
1510
- * @type {string}
1511
- * @memberof OrdersApiRetryPlatformPayment
1512
854
  */
1513
855
  readonly orderId: string;
1514
856
  /**
1515
857
  * Specifies which fields to return, separated by commas
1516
- * @type {string}
1517
- * @memberof OrdersApiRetryPlatformPayment
1518
858
  */
1519
859
  readonly fields?: string;
1520
860
  }
1521
861
  /**
1522
862
  * OrdersApi - object-oriented interface
1523
- * @export
1524
- * @class OrdersApi
1525
- * @extends {BaseAPI}
1526
863
  */
1527
864
  export declare class OrdersApi extends BaseAPI {
1528
865
  /**
@@ -1531,76 +868,65 @@ export declare class OrdersApi extends BaseAPI {
1531
868
  * @param {OrdersApiCancelOrderRequest} requestParameters Request parameters.
1532
869
  * @param {*} [options] Override http request option.
1533
870
  * @throws {RequiredError}
1534
- * @memberof OrdersApi
1535
871
  */
1536
- cancelOrder(requestParameters: OrdersApiCancelOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
872
+ cancelOrder(requestParameters: OrdersApiCancelOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
1537
873
  /**
1538
874
  * Confirms an order, and submits it as ready to take payment and begin processing.
1539
875
  * @summary Confirm order
1540
876
  * @param {OrdersApiConfirmOrderRequest} requestParameters Request parameters.
1541
877
  * @param {*} [options] Override http request option.
1542
878
  * @throws {RequiredError}
1543
- * @memberof OrdersApi
1544
879
  */
1545
- confirmOrder(requestParameters: OrdersApiConfirmOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
880
+ confirmOrder(requestParameters: OrdersApiConfirmOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any, {}>>;
1546
881
  /**
1547
882
  * Creates a new order for the provided variants. You can fetch details and references to the given project\'s variants from the Product Catalog API.
1548
883
  * @summary Create order
1549
884
  * @param {OrdersApiCreateOrderRequest} requestParameters Request parameters.
1550
885
  * @param {*} [options] Override http request option.
1551
886
  * @throws {RequiredError}
1552
- * @memberof OrdersApi
1553
887
  */
1554
- createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
888
+ createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any, {}>>;
1555
889
  /**
1556
890
  * Download an order invoice.
1557
891
  * @summary Download order invoice
1558
892
  * @param {OrdersApiDownloadInvoiceRequest} requestParameters Request parameters.
1559
893
  * @param {*} [options] Override http request option.
1560
894
  * @throws {RequiredError}
1561
- * @memberof OrdersApi
1562
895
  */
1563
- downloadInvoice(requestParameters: OrdersApiDownloadInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
896
+ downloadInvoice(requestParameters: OrdersApiDownloadInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
1564
897
  /**
1565
898
  * Export orders as a CSV file
1566
899
  * @summary Export orders
1567
900
  * @param {OrdersApiExportOrdersRequest} requestParameters Request parameters.
1568
901
  * @param {*} [options] Override http request option.
1569
902
  * @throws {RequiredError}
1570
- * @memberof OrdersApi
1571
903
  */
1572
- exportOrders(requestParameters: OrdersApiExportOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
904
+ exportOrders(requestParameters: OrdersApiExportOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
1573
905
  /**
1574
906
  * Get an order by a given ID.
1575
907
  * @summary Get order
1576
908
  * @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
1577
909
  * @param {*} [options] Override http request option.
1578
910
  * @throws {RequiredError}
1579
- * @memberof OrdersApi
1580
911
  */
1581
- getOrder(requestParameters: OrdersApiGetOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
912
+ getOrder(requestParameters: OrdersApiGetOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any, {}>>;
1582
913
  /**
1583
914
  * Lists all orders placed on this project, paginated into configurable chunks.
1584
915
  * @summary List orders
1585
916
  * @param {OrdersApiGetOrdersRequest} requestParameters Request parameters.
1586
917
  * @param {*} [options] Override http request option.
1587
918
  * @throws {RequiredError}
1588
- * @memberof OrdersApi
1589
919
  */
1590
- getOrders(requestParameters: OrdersApiGetOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrdersResponse, any>>;
920
+ getOrders(requestParameters: OrdersApiGetOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrdersResponse, any, {}>>;
1591
921
  /**
1592
922
  * Retries failed platform payment, so fulfillment can proceed.
1593
923
  * @summary Retry
1594
924
  * @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
1595
925
  * @param {*} [options] Override http request option.
1596
926
  * @throws {RequiredError}
1597
- * @memberof OrdersApi
1598
927
  */
1599
- retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
928
+ retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any, {}>>;
1600
929
  }
1601
- /**
1602
- * @export
1603
- */
1604
930
  export declare const GetOrdersDateFilterTypeEnum: {
1605
931
  readonly CreatedAt: "createdAt";
1606
932
  readonly UpdatedAt: "updatedAt";