@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/README.md +6 -3
- package/api.ts +20 -693
- package/base.ts +1 -25
- package/common.ts +1 -2
- package/configuration.ts +1 -18
- package/dist/api.d.ts +27 -701
- package/dist/api.js +1 -23
- package/dist/base.d.ts +1 -25
- package/dist/base.js +1 -20
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -18
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +27 -701
- package/dist/esm/api.js +1 -23
- package/dist/esm/base.d.ts +1 -25
- package/dist/esm/base.js +1 -20
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -18
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/ConfirmOrderFulfillment.md +2 -2
- package/docs/ConfirmOrderFulfillmentWithShipment.md +22 -0
- package/docs/ConfirmOrderFulfillmentWithShipmentShipment.md +21 -0
- package/docs/ConfirmOrderFulfillmentWithShippingMethod.md +22 -0
- package/docs/Order.md +2 -0
- package/docs/PaymentMethod.md +20 -0
- package/index.ts +1 -1
- package/package.json +1 -1
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.
|
|
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
|
|
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
|
|
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,466 +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 {Address}
|
|
596
|
-
* @memberof Order
|
|
597
|
-
*/
|
|
293
|
+
'paymentMethod'?: PaymentMethod;
|
|
598
294
|
'shippingAddress': Address;
|
|
599
|
-
/**
|
|
600
|
-
*
|
|
601
|
-
* @type {CustomsInformation1}
|
|
602
|
-
* @memberof Order
|
|
603
|
-
*/
|
|
604
295
|
'customsInformation'?: CustomsInformation1;
|
|
605
296
|
/**
|
|
606
297
|
* ISO 8601 Timestamp
|
|
607
|
-
* @type {string}
|
|
608
|
-
* @memberof Order
|
|
609
298
|
*/
|
|
610
299
|
'createdAt'?: string;
|
|
611
300
|
/**
|
|
612
301
|
* ISO 8601 Timestamp
|
|
613
|
-
* @type {string}
|
|
614
|
-
* @memberof Order
|
|
615
302
|
*/
|
|
616
303
|
'updatedAt'?: string;
|
|
617
304
|
/**
|
|
618
305
|
* ISO 8601 Timestamp
|
|
619
|
-
* @type {string}
|
|
620
|
-
* @memberof Order
|
|
621
306
|
*/
|
|
622
307
|
'statusChangedAt'?: string;
|
|
623
308
|
/**
|
|
624
309
|
* A custom reference to the merchant\'s order.
|
|
625
|
-
* @type {string}
|
|
626
|
-
* @memberof Order
|
|
627
310
|
*/
|
|
628
311
|
'merchantReference'?: string | null;
|
|
629
|
-
/**
|
|
630
|
-
*
|
|
631
|
-
* @type {Array<Fulfillment>}
|
|
632
|
-
* @memberof Order
|
|
633
|
-
*/
|
|
634
312
|
'fulfillments'?: Array<Fulfillment>;
|
|
635
|
-
/**
|
|
636
|
-
*
|
|
637
|
-
* @type {Array<OrderItem>}
|
|
638
|
-
* @memberof Order
|
|
639
|
-
*/
|
|
640
313
|
'items': Array<OrderItem>;
|
|
641
|
-
/**
|
|
642
|
-
*
|
|
643
|
-
* @type {Price}
|
|
644
|
-
* @memberof Order
|
|
645
|
-
*/
|
|
646
314
|
'totalPrice'?: Price;
|
|
647
|
-
/**
|
|
648
|
-
*
|
|
649
|
-
* @type {Price}
|
|
650
|
-
* @memberof Order
|
|
651
|
-
*/
|
|
652
315
|
'taxPrice'?: Price;
|
|
653
|
-
/**
|
|
654
|
-
*
|
|
655
|
-
* @type {Price}
|
|
656
|
-
* @memberof Order
|
|
657
|
-
*/
|
|
658
316
|
'subtotalPrice'?: Price;
|
|
659
|
-
/**
|
|
660
|
-
*
|
|
661
|
-
* @type {Price}
|
|
662
|
-
* @memberof Order
|
|
663
|
-
*/
|
|
664
317
|
'discountPrice'?: Price;
|
|
665
|
-
/**
|
|
666
|
-
*
|
|
667
|
-
* @type {Coupon}
|
|
668
|
-
* @memberof Order
|
|
669
|
-
*/
|
|
670
318
|
'coupon'?: Coupon | null;
|
|
671
|
-
/**
|
|
672
|
-
*
|
|
673
|
-
* @type {Price}
|
|
674
|
-
* @memberof Order
|
|
675
|
-
*/
|
|
676
319
|
'shippingPrice'?: Price;
|
|
677
|
-
/**
|
|
678
|
-
*
|
|
679
|
-
* @type {Origin}
|
|
680
|
-
* @memberof Order
|
|
681
|
-
*/
|
|
682
320
|
'origin'?: Origin;
|
|
683
|
-
/**
|
|
684
|
-
*
|
|
685
|
-
* @type {Array<StatusHistoryItem>}
|
|
686
|
-
* @memberof Order
|
|
687
|
-
*/
|
|
688
321
|
'statusHistory'?: Array<StatusHistoryItem>;
|
|
689
|
-
/**
|
|
690
|
-
*
|
|
691
|
-
* @type {Array<PaymentAttempt>}
|
|
692
|
-
* @memberof Order
|
|
693
|
-
*/
|
|
694
322
|
'paymentAttempts'?: Array<PaymentAttempt>;
|
|
695
323
|
}
|
|
696
324
|
|
|
697
325
|
|
|
698
|
-
/**
|
|
699
|
-
*
|
|
700
|
-
* @export
|
|
701
|
-
* @interface OrderItem
|
|
702
|
-
*/
|
|
703
326
|
export interface OrderItem {
|
|
704
327
|
/**
|
|
705
328
|
* Unique object identifier
|
|
706
|
-
* @type {string}
|
|
707
|
-
* @memberof OrderItem
|
|
708
329
|
*/
|
|
709
330
|
'id'?: string;
|
|
710
331
|
/**
|
|
711
332
|
* A reference to the variant being ordered
|
|
712
|
-
* @type {string}
|
|
713
|
-
* @memberof OrderItem
|
|
714
333
|
*/
|
|
715
334
|
'variantRef': string;
|
|
716
335
|
/**
|
|
717
336
|
* Options associated to an order item\'s variant, such as color and size.
|
|
718
|
-
* @type {Array<Option>}
|
|
719
|
-
* @memberof OrderItem
|
|
720
337
|
*/
|
|
721
338
|
'options'?: Array<Option>;
|
|
722
|
-
/**
|
|
723
|
-
*
|
|
724
|
-
* @type {number}
|
|
725
|
-
* @memberof OrderItem
|
|
726
|
-
*/
|
|
727
339
|
'quantity': number;
|
|
728
340
|
/**
|
|
729
341
|
* The name of the product
|
|
730
|
-
* @type {string}
|
|
731
|
-
* @memberof OrderItem
|
|
732
342
|
*/
|
|
733
343
|
'name'?: string;
|
|
734
344
|
/**
|
|
735
345
|
* Images
|
|
736
|
-
* @type {Array<Image>}
|
|
737
|
-
* @memberof OrderItem
|
|
738
346
|
*/
|
|
739
347
|
'images'?: Array<Image>;
|
|
740
|
-
/**
|
|
741
|
-
*
|
|
742
|
-
* @type {Price}
|
|
743
|
-
* @memberof OrderItem
|
|
744
|
-
*/
|
|
745
348
|
'totalPrice'?: Price;
|
|
746
349
|
/**
|
|
747
350
|
* This is an estimate until the order has been confirmed
|
|
748
|
-
* @type {Price}
|
|
749
|
-
* @memberof OrderItem
|
|
750
351
|
*/
|
|
751
352
|
'taxPrice'?: Price;
|
|
752
|
-
/**
|
|
753
|
-
*
|
|
754
|
-
* @type {Price}
|
|
755
|
-
* @memberof OrderItem
|
|
756
|
-
*/
|
|
757
353
|
'subtotalPrice'?: Price;
|
|
758
|
-
/**
|
|
759
|
-
*
|
|
760
|
-
* @type {Price}
|
|
761
|
-
* @memberof OrderItem
|
|
762
|
-
*/
|
|
763
354
|
'discountPrice'?: Price;
|
|
764
355
|
/**
|
|
765
356
|
* The price you charged the recipient for each item. It\'s highly recommended if you have international orders as it aids customs issues.
|
|
766
|
-
* @type {Price}
|
|
767
|
-
* @memberof OrderItem
|
|
768
357
|
*/
|
|
769
358
|
'recipientCost'?: Price;
|
|
770
359
|
}
|
|
771
|
-
/**
|
|
772
|
-
*
|
|
773
|
-
* @export
|
|
774
|
-
* @interface OrderItem1
|
|
775
|
-
*/
|
|
776
360
|
export interface OrderItem1 {
|
|
777
361
|
/**
|
|
778
362
|
* A reference to the variant being ordered
|
|
779
|
-
* @type {string}
|
|
780
|
-
* @memberof OrderItem1
|
|
781
363
|
*/
|
|
782
364
|
'variantRef': string;
|
|
783
|
-
/**
|
|
784
|
-
*
|
|
785
|
-
* @type {number}
|
|
786
|
-
* @memberof OrderItem1
|
|
787
|
-
*/
|
|
788
365
|
'quantity': number;
|
|
789
|
-
/**
|
|
790
|
-
*
|
|
791
|
-
* @type {OrderItem1RecipientCost}
|
|
792
|
-
* @memberof OrderItem1
|
|
793
|
-
*/
|
|
794
366
|
'recipientCost'?: OrderItem1RecipientCost;
|
|
795
367
|
}
|
|
796
|
-
/**
|
|
797
|
-
*
|
|
798
|
-
* @export
|
|
799
|
-
* @interface OrderItem1RecipientCost
|
|
800
|
-
*/
|
|
801
368
|
export interface OrderItem1RecipientCost {
|
|
802
|
-
/**
|
|
803
|
-
*
|
|
804
|
-
* @type {string}
|
|
805
|
-
* @memberof OrderItem1RecipientCost
|
|
806
|
-
*/
|
|
807
369
|
'amount': string;
|
|
808
|
-
/**
|
|
809
|
-
*
|
|
810
|
-
* @type {string}
|
|
811
|
-
* @memberof OrderItem1RecipientCost
|
|
812
|
-
*/
|
|
813
370
|
'currencyCode': string;
|
|
814
371
|
}
|
|
815
|
-
/**
|
|
816
|
-
*
|
|
817
|
-
* @export
|
|
818
|
-
* @interface OrderTracking
|
|
819
|
-
*/
|
|
820
372
|
export interface OrderTracking {
|
|
821
|
-
/**
|
|
822
|
-
*
|
|
823
|
-
* @type {string}
|
|
824
|
-
* @memberof OrderTracking
|
|
825
|
-
*/
|
|
826
373
|
'courier'?: string;
|
|
827
|
-
/**
|
|
828
|
-
*
|
|
829
|
-
* @type {string}
|
|
830
|
-
* @memberof OrderTracking
|
|
831
|
-
*/
|
|
832
374
|
'code'?: string;
|
|
833
|
-
/**
|
|
834
|
-
*
|
|
835
|
-
* @type {string}
|
|
836
|
-
* @memberof OrderTracking
|
|
837
|
-
*/
|
|
838
375
|
'url'?: string;
|
|
839
376
|
}
|
|
840
|
-
/**
|
|
841
|
-
*
|
|
842
|
-
* @export
|
|
843
|
-
* @interface OrdersResponse
|
|
844
|
-
*/
|
|
845
377
|
export interface OrdersResponse {
|
|
846
|
-
/**
|
|
847
|
-
*
|
|
848
|
-
* @type {Array<Order>}
|
|
849
|
-
* @memberof OrdersResponse
|
|
850
|
-
*/
|
|
851
378
|
'orders'?: Array<Order>;
|
|
852
379
|
/**
|
|
853
380
|
* The token referencing the next page number
|
|
854
|
-
* @type {number}
|
|
855
|
-
* @memberof OrdersResponse
|
|
856
381
|
*/
|
|
857
382
|
'nextPageToken'?: number | null;
|
|
858
383
|
}
|
|
859
|
-
/**
|
|
860
|
-
*
|
|
861
|
-
* @export
|
|
862
|
-
* @interface Origin
|
|
863
|
-
*/
|
|
864
384
|
export interface Origin {
|
|
865
|
-
/**
|
|
866
|
-
*
|
|
867
|
-
* @type {string}
|
|
868
|
-
* @memberof Origin
|
|
869
|
-
*/
|
|
870
385
|
'code'?: string;
|
|
871
|
-
/**
|
|
872
|
-
*
|
|
873
|
-
* @type {boolean}
|
|
874
|
-
* @memberof Origin
|
|
875
|
-
*/
|
|
876
386
|
'isPaid'?: boolean;
|
|
877
387
|
}
|
|
878
388
|
/**
|
|
879
389
|
* List of payment attempts for this order
|
|
880
|
-
* @export
|
|
881
|
-
* @interface PaymentAttempt
|
|
882
390
|
*/
|
|
883
391
|
export interface PaymentAttempt {
|
|
884
|
-
/**
|
|
885
|
-
*
|
|
886
|
-
* @type {string}
|
|
887
|
-
* @memberof PaymentAttempt
|
|
888
|
-
*/
|
|
889
392
|
'paymentProvider'?: PaymentAttemptPaymentProviderEnum;
|
|
890
|
-
/**
|
|
891
|
-
*
|
|
892
|
-
* @type {string}
|
|
893
|
-
* @memberof PaymentAttempt
|
|
894
|
-
*/
|
|
895
393
|
'status'?: PaymentAttemptStatusEnum;
|
|
896
|
-
/**
|
|
897
|
-
*
|
|
898
|
-
* @type {string}
|
|
899
|
-
* @memberof PaymentAttempt
|
|
900
|
-
*/
|
|
901
394
|
'transactionId'?: string | null;
|
|
902
|
-
/**
|
|
903
|
-
*
|
|
904
|
-
* @type {string}
|
|
905
|
-
* @memberof PaymentAttempt
|
|
906
|
-
*/
|
|
907
395
|
'message'?: string;
|
|
908
396
|
/**
|
|
909
397
|
* ISO 8601 Timestamp
|
|
910
|
-
* @type {string}
|
|
911
|
-
* @memberof PaymentAttempt
|
|
912
398
|
*/
|
|
913
399
|
'createdAt'?: string;
|
|
914
400
|
}
|
|
@@ -929,85 +415,35 @@ export const PaymentAttemptStatusEnum = {
|
|
|
929
415
|
|
|
930
416
|
export type PaymentAttemptStatusEnum = typeof PaymentAttemptStatusEnum[keyof typeof PaymentAttemptStatusEnum];
|
|
931
417
|
|
|
418
|
+
export interface PaymentMethod {
|
|
419
|
+
'type'?: string;
|
|
420
|
+
}
|
|
932
421
|
/**
|
|
933
422
|
* Standard price definition that defines the amount and currency.
|
|
934
|
-
* @export
|
|
935
|
-
* @interface Price
|
|
936
423
|
*/
|
|
937
424
|
export interface Price {
|
|
938
425
|
/**
|
|
939
426
|
* Price including tax in the specified currency.
|
|
940
|
-
* @type {string}
|
|
941
|
-
* @memberof Price
|
|
942
427
|
*/
|
|
943
428
|
'amount'?: string;
|
|
944
429
|
/**
|
|
945
430
|
* Currency code for the currency the price is valued in.
|
|
946
|
-
* @type {string}
|
|
947
|
-
* @memberof Price
|
|
948
431
|
*/
|
|
949
432
|
'currencyCode'?: string;
|
|
950
433
|
}
|
|
951
|
-
/**
|
|
952
|
-
*
|
|
953
|
-
* @export
|
|
954
|
-
* @interface ShippingMethod
|
|
955
|
-
*/
|
|
956
434
|
export interface ShippingMethod {
|
|
957
435
|
/**
|
|
958
436
|
* Unique object identifier
|
|
959
|
-
* @type {string}
|
|
960
|
-
* @memberof ShippingMethod
|
|
961
437
|
*/
|
|
962
438
|
'id'?: string;
|
|
963
|
-
/**
|
|
964
|
-
*
|
|
965
|
-
* @type {string}
|
|
966
|
-
* @memberof ShippingMethod
|
|
967
|
-
*/
|
|
968
439
|
'name'?: string;
|
|
969
|
-
/**
|
|
970
|
-
*
|
|
971
|
-
* @type {string}
|
|
972
|
-
* @memberof ShippingMethod
|
|
973
|
-
*/
|
|
974
440
|
'description'?: string;
|
|
975
|
-
/**
|
|
976
|
-
*
|
|
977
|
-
* @type {DeliveryEstimates}
|
|
978
|
-
* @memberof ShippingMethod
|
|
979
|
-
*/
|
|
980
441
|
'deliveryEstimates'?: DeliveryEstimates;
|
|
981
|
-
/**
|
|
982
|
-
*
|
|
983
|
-
* @type {Price}
|
|
984
|
-
* @memberof ShippingMethod
|
|
985
|
-
*/
|
|
986
442
|
'totalPrice'?: Price;
|
|
987
|
-
/**
|
|
988
|
-
*
|
|
989
|
-
* @type {Price}
|
|
990
|
-
* @memberof ShippingMethod
|
|
991
|
-
*/
|
|
992
443
|
'taxPrice'?: Price;
|
|
993
|
-
/**
|
|
994
|
-
*
|
|
995
|
-
* @type {Price}
|
|
996
|
-
* @memberof ShippingMethod
|
|
997
|
-
*/
|
|
998
444
|
'subtotalPrice'?: Price;
|
|
999
|
-
/**
|
|
1000
|
-
*
|
|
1001
|
-
* @type {Price}
|
|
1002
|
-
* @memberof ShippingMethod
|
|
1003
|
-
*/
|
|
1004
445
|
'discountPrice'?: Price;
|
|
1005
446
|
}
|
|
1006
|
-
/**
|
|
1007
|
-
*
|
|
1008
|
-
* @export
|
|
1009
|
-
* @enum {string}
|
|
1010
|
-
*/
|
|
1011
447
|
|
|
1012
448
|
export const Status = {
|
|
1013
449
|
New: 'new',
|
|
@@ -1021,22 +457,10 @@ export const Status = {
|
|
|
1021
457
|
export type Status = typeof Status[keyof typeof Status];
|
|
1022
458
|
|
|
1023
459
|
|
|
1024
|
-
/**
|
|
1025
|
-
*
|
|
1026
|
-
* @export
|
|
1027
|
-
* @interface StatusHistoryItem
|
|
1028
|
-
*/
|
|
1029
460
|
export interface StatusHistoryItem {
|
|
1030
|
-
/**
|
|
1031
|
-
*
|
|
1032
|
-
* @type {Status}
|
|
1033
|
-
* @memberof StatusHistoryItem
|
|
1034
|
-
*/
|
|
1035
461
|
'status'?: Status;
|
|
1036
462
|
/**
|
|
1037
463
|
* ISO 8601 Timestamp
|
|
1038
|
-
* @type {string}
|
|
1039
|
-
* @memberof StatusHistoryItem
|
|
1040
464
|
*/
|
|
1041
465
|
'createdAt'?: string;
|
|
1042
466
|
}
|
|
@@ -1045,7 +469,6 @@ export interface StatusHistoryItem {
|
|
|
1045
469
|
|
|
1046
470
|
/**
|
|
1047
471
|
* OrdersApi - axios parameter creator
|
|
1048
|
-
* @export
|
|
1049
472
|
*/
|
|
1050
473
|
export const OrdersApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
1051
474
|
return {
|
|
@@ -1533,7 +956,6 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
1533
956
|
|
|
1534
957
|
/**
|
|
1535
958
|
* OrdersApi - functional programming interface
|
|
1536
|
-
* @export
|
|
1537
959
|
*/
|
|
1538
960
|
export const OrdersApiFp = function(configuration?: Configuration) {
|
|
1539
961
|
const localVarAxiosParamCreator = OrdersApiAxiosParamCreator(configuration)
|
|
@@ -1671,7 +1093,6 @@ export const OrdersApiFp = function(configuration?: Configuration) {
|
|
|
1671
1093
|
|
|
1672
1094
|
/**
|
|
1673
1095
|
* OrdersApi - factory interface
|
|
1674
|
-
* @export
|
|
1675
1096
|
*/
|
|
1676
1097
|
export const OrdersApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
1677
1098
|
const localVarFp = OrdersApiFp(configuration)
|
|
@@ -1761,289 +1182,206 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
|
|
|
1761
1182
|
|
|
1762
1183
|
/**
|
|
1763
1184
|
* Request parameters for cancelOrder operation in OrdersApi.
|
|
1764
|
-
* @export
|
|
1765
|
-
* @interface OrdersApiCancelOrderRequest
|
|
1766
1185
|
*/
|
|
1767
1186
|
export interface OrdersApiCancelOrderRequest {
|
|
1768
1187
|
/**
|
|
1769
1188
|
* What project it is
|
|
1770
|
-
* @type {string}
|
|
1771
|
-
* @memberof OrdersApiCancelOrder
|
|
1772
1189
|
*/
|
|
1773
1190
|
readonly project: string
|
|
1774
1191
|
|
|
1775
1192
|
/**
|
|
1776
1193
|
* Unique identifier of an order
|
|
1777
|
-
* @type {string}
|
|
1778
|
-
* @memberof OrdersApiCancelOrder
|
|
1779
1194
|
*/
|
|
1780
1195
|
readonly orderId: string
|
|
1781
1196
|
|
|
1782
1197
|
/**
|
|
1783
1198
|
* Specifies which fields to return, separated by commas
|
|
1784
|
-
* @type {string}
|
|
1785
|
-
* @memberof OrdersApiCancelOrder
|
|
1786
1199
|
*/
|
|
1787
1200
|
readonly fields?: string
|
|
1788
1201
|
}
|
|
1789
1202
|
|
|
1790
1203
|
/**
|
|
1791
1204
|
* Request parameters for confirmOrder operation in OrdersApi.
|
|
1792
|
-
* @export
|
|
1793
|
-
* @interface OrdersApiConfirmOrderRequest
|
|
1794
1205
|
*/
|
|
1795
1206
|
export interface OrdersApiConfirmOrderRequest {
|
|
1796
1207
|
/**
|
|
1797
1208
|
* What project it is
|
|
1798
|
-
* @type {string}
|
|
1799
|
-
* @memberof OrdersApiConfirmOrder
|
|
1800
1209
|
*/
|
|
1801
1210
|
readonly project: string
|
|
1802
1211
|
|
|
1803
1212
|
/**
|
|
1804
1213
|
* Unique identifier of an order
|
|
1805
|
-
* @type {string}
|
|
1806
|
-
* @memberof OrdersApiConfirmOrder
|
|
1807
1214
|
*/
|
|
1808
1215
|
readonly orderId: string
|
|
1809
1216
|
|
|
1810
1217
|
/**
|
|
1811
1218
|
* ConfirmFulfillment schema
|
|
1812
|
-
* @type {ConfirmOrderRequest}
|
|
1813
|
-
* @memberof OrdersApiConfirmOrder
|
|
1814
1219
|
*/
|
|
1815
1220
|
readonly confirmOrderRequest: ConfirmOrderRequest
|
|
1816
1221
|
|
|
1817
1222
|
/**
|
|
1818
1223
|
* Specifies which fields to return, separated by commas
|
|
1819
|
-
* @type {string}
|
|
1820
|
-
* @memberof OrdersApiConfirmOrder
|
|
1821
1224
|
*/
|
|
1822
1225
|
readonly fields?: string
|
|
1823
1226
|
}
|
|
1824
1227
|
|
|
1825
1228
|
/**
|
|
1826
1229
|
* Request parameters for createOrder operation in OrdersApi.
|
|
1827
|
-
* @export
|
|
1828
|
-
* @interface OrdersApiCreateOrderRequest
|
|
1829
1230
|
*/
|
|
1830
1231
|
export interface OrdersApiCreateOrderRequest {
|
|
1831
1232
|
/**
|
|
1832
1233
|
* What project it is
|
|
1833
|
-
* @type {string}
|
|
1834
|
-
* @memberof OrdersApiCreateOrder
|
|
1835
1234
|
*/
|
|
1836
1235
|
readonly project: string
|
|
1837
1236
|
|
|
1838
1237
|
/**
|
|
1839
1238
|
* Create Order schema
|
|
1840
|
-
* @type {CreateOrder}
|
|
1841
|
-
* @memberof OrdersApiCreateOrder
|
|
1842
1239
|
*/
|
|
1843
1240
|
readonly createOrder: CreateOrder
|
|
1844
1241
|
|
|
1845
1242
|
/**
|
|
1846
1243
|
* Specifies which fields to return, separated by commas
|
|
1847
|
-
* @type {string}
|
|
1848
|
-
* @memberof OrdersApiCreateOrder
|
|
1849
1244
|
*/
|
|
1850
1245
|
readonly fields?: string
|
|
1851
1246
|
}
|
|
1852
1247
|
|
|
1853
1248
|
/**
|
|
1854
1249
|
* Request parameters for downloadInvoice operation in OrdersApi.
|
|
1855
|
-
* @export
|
|
1856
|
-
* @interface OrdersApiDownloadInvoiceRequest
|
|
1857
1250
|
*/
|
|
1858
1251
|
export interface OrdersApiDownloadInvoiceRequest {
|
|
1859
1252
|
/**
|
|
1860
1253
|
* What project it is
|
|
1861
|
-
* @type {string}
|
|
1862
|
-
* @memberof OrdersApiDownloadInvoice
|
|
1863
1254
|
*/
|
|
1864
1255
|
readonly project: string
|
|
1865
1256
|
|
|
1866
1257
|
/**
|
|
1867
1258
|
* Unique identifier of an order
|
|
1868
|
-
* @type {string}
|
|
1869
|
-
* @memberof OrdersApiDownloadInvoice
|
|
1870
1259
|
*/
|
|
1871
1260
|
readonly orderId: string
|
|
1872
1261
|
}
|
|
1873
1262
|
|
|
1874
1263
|
/**
|
|
1875
1264
|
* Request parameters for exportOrders operation in OrdersApi.
|
|
1876
|
-
* @export
|
|
1877
|
-
* @interface OrdersApiExportOrdersRequest
|
|
1878
1265
|
*/
|
|
1879
1266
|
export interface OrdersApiExportOrdersRequest {
|
|
1880
1267
|
/**
|
|
1881
1268
|
* What project it is
|
|
1882
|
-
* @type {string}
|
|
1883
|
-
* @memberof OrdersApiExportOrders
|
|
1884
1269
|
*/
|
|
1885
1270
|
readonly project: string
|
|
1886
1271
|
|
|
1887
1272
|
/**
|
|
1888
1273
|
* Start of date range to filter by when orders were placed
|
|
1889
|
-
* @type {string}
|
|
1890
|
-
* @memberof OrdersApiExportOrders
|
|
1891
1274
|
*/
|
|
1892
1275
|
readonly start: string
|
|
1893
1276
|
|
|
1894
1277
|
/**
|
|
1895
1278
|
* End of date range
|
|
1896
|
-
* @type {string}
|
|
1897
|
-
* @memberof OrdersApiExportOrders
|
|
1898
1279
|
*/
|
|
1899
1280
|
readonly end?: string
|
|
1900
1281
|
|
|
1901
1282
|
/**
|
|
1902
1283
|
* Search term to filter based on order reference, customer name and email
|
|
1903
|
-
* @type {string}
|
|
1904
|
-
* @memberof OrdersApiExportOrders
|
|
1905
1284
|
*/
|
|
1906
1285
|
readonly search?: string
|
|
1907
1286
|
}
|
|
1908
1287
|
|
|
1909
1288
|
/**
|
|
1910
1289
|
* Request parameters for getOrder operation in OrdersApi.
|
|
1911
|
-
* @export
|
|
1912
|
-
* @interface OrdersApiGetOrderRequest
|
|
1913
1290
|
*/
|
|
1914
1291
|
export interface OrdersApiGetOrderRequest {
|
|
1915
1292
|
/**
|
|
1916
1293
|
* What project it is
|
|
1917
|
-
* @type {string}
|
|
1918
|
-
* @memberof OrdersApiGetOrder
|
|
1919
1294
|
*/
|
|
1920
1295
|
readonly project: string
|
|
1921
1296
|
|
|
1922
1297
|
/**
|
|
1923
1298
|
* Unique identifier of an order
|
|
1924
|
-
* @type {string}
|
|
1925
|
-
* @memberof OrdersApiGetOrder
|
|
1926
1299
|
*/
|
|
1927
1300
|
readonly orderId: string
|
|
1928
1301
|
|
|
1929
1302
|
/**
|
|
1930
1303
|
* Specifies which fields to return, separated by commas
|
|
1931
|
-
* @type {string}
|
|
1932
|
-
* @memberof OrdersApiGetOrder
|
|
1933
1304
|
*/
|
|
1934
1305
|
readonly fields?: string
|
|
1935
1306
|
}
|
|
1936
1307
|
|
|
1937
1308
|
/**
|
|
1938
1309
|
* Request parameters for getOrders operation in OrdersApi.
|
|
1939
|
-
* @export
|
|
1940
|
-
* @interface OrdersApiGetOrdersRequest
|
|
1941
1310
|
*/
|
|
1942
1311
|
export interface OrdersApiGetOrdersRequest {
|
|
1943
1312
|
/**
|
|
1944
1313
|
* What project it is
|
|
1945
|
-
* @type {string}
|
|
1946
|
-
* @memberof OrdersApiGetOrders
|
|
1947
1314
|
*/
|
|
1948
1315
|
readonly project: string
|
|
1949
1316
|
|
|
1950
1317
|
/**
|
|
1951
1318
|
* Specifies which fields to return, separated by commas
|
|
1952
|
-
* @type {string}
|
|
1953
|
-
* @memberof OrdersApiGetOrders
|
|
1954
1319
|
*/
|
|
1955
1320
|
readonly fields?: string
|
|
1956
1321
|
|
|
1957
1322
|
/**
|
|
1958
1323
|
* Page reference token
|
|
1959
|
-
* @type {number}
|
|
1960
|
-
* @memberof OrdersApiGetOrders
|
|
1961
1324
|
*/
|
|
1962
1325
|
readonly pageToken?: number
|
|
1963
1326
|
|
|
1964
1327
|
/**
|
|
1965
1328
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1966
|
-
* @type {number}
|
|
1967
|
-
* @memberof OrdersApiGetOrders
|
|
1968
1329
|
*/
|
|
1969
1330
|
readonly pageSize?: number
|
|
1970
1331
|
|
|
1971
1332
|
/**
|
|
1972
1333
|
* Search term to filter based on order reference, customer name and email
|
|
1973
|
-
* @type {string}
|
|
1974
|
-
* @memberof OrdersApiGetOrders
|
|
1975
1334
|
*/
|
|
1976
1335
|
readonly search?: string
|
|
1977
1336
|
|
|
1978
1337
|
/**
|
|
1979
1338
|
* Specify fulfillment IDs to list
|
|
1980
|
-
* @type {Array<string>}
|
|
1981
|
-
* @memberof OrdersApiGetOrders
|
|
1982
1339
|
*/
|
|
1983
1340
|
readonly ids?: Array<string>
|
|
1984
1341
|
|
|
1985
1342
|
/**
|
|
1986
1343
|
* Filter by fulfillment status
|
|
1987
|
-
* @type {Array<Status>}
|
|
1988
|
-
* @memberof OrdersApiGetOrders
|
|
1989
1344
|
*/
|
|
1990
1345
|
readonly statuses?: Array<Status>
|
|
1991
1346
|
|
|
1992
1347
|
/**
|
|
1993
1348
|
* Start of date range
|
|
1994
|
-
* @type {string}
|
|
1995
|
-
* @memberof OrdersApiGetOrders
|
|
1996
1349
|
*/
|
|
1997
1350
|
readonly start?: string
|
|
1998
1351
|
|
|
1999
1352
|
/**
|
|
2000
1353
|
* End of date range
|
|
2001
|
-
* @type {string}
|
|
2002
|
-
* @memberof OrdersApiGetOrders
|
|
2003
1354
|
*/
|
|
2004
1355
|
readonly end?: string
|
|
2005
1356
|
|
|
2006
1357
|
/**
|
|
2007
1358
|
* Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
2008
|
-
* @type {'createdAt' | 'updatedAt' | 'statusChangedAt'}
|
|
2009
|
-
* @memberof OrdersApiGetOrders
|
|
2010
1359
|
*/
|
|
2011
1360
|
readonly dateFilterType?: GetOrdersDateFilterTypeEnum
|
|
2012
1361
|
}
|
|
2013
1362
|
|
|
2014
1363
|
/**
|
|
2015
1364
|
* Request parameters for retryPlatformPayment operation in OrdersApi.
|
|
2016
|
-
* @export
|
|
2017
|
-
* @interface OrdersApiRetryPlatformPaymentRequest
|
|
2018
1365
|
*/
|
|
2019
1366
|
export interface OrdersApiRetryPlatformPaymentRequest {
|
|
2020
1367
|
/**
|
|
2021
1368
|
* What project it is
|
|
2022
|
-
* @type {string}
|
|
2023
|
-
* @memberof OrdersApiRetryPlatformPayment
|
|
2024
1369
|
*/
|
|
2025
1370
|
readonly project: string
|
|
2026
1371
|
|
|
2027
1372
|
/**
|
|
2028
1373
|
* Unique identifier of an order
|
|
2029
|
-
* @type {string}
|
|
2030
|
-
* @memberof OrdersApiRetryPlatformPayment
|
|
2031
1374
|
*/
|
|
2032
1375
|
readonly orderId: string
|
|
2033
1376
|
|
|
2034
1377
|
/**
|
|
2035
1378
|
* Specifies which fields to return, separated by commas
|
|
2036
|
-
* @type {string}
|
|
2037
|
-
* @memberof OrdersApiRetryPlatformPayment
|
|
2038
1379
|
*/
|
|
2039
1380
|
readonly fields?: string
|
|
2040
1381
|
}
|
|
2041
1382
|
|
|
2042
1383
|
/**
|
|
2043
1384
|
* OrdersApi - object-oriented interface
|
|
2044
|
-
* @export
|
|
2045
|
-
* @class OrdersApi
|
|
2046
|
-
* @extends {BaseAPI}
|
|
2047
1385
|
*/
|
|
2048
1386
|
export class OrdersApi extends BaseAPI {
|
|
2049
1387
|
/**
|
|
@@ -2052,7 +1390,6 @@ export class OrdersApi extends BaseAPI {
|
|
|
2052
1390
|
* @param {OrdersApiCancelOrderRequest} requestParameters Request parameters.
|
|
2053
1391
|
* @param {*} [options] Override http request option.
|
|
2054
1392
|
* @throws {RequiredError}
|
|
2055
|
-
* @memberof OrdersApi
|
|
2056
1393
|
*/
|
|
2057
1394
|
public cancelOrder(requestParameters: OrdersApiCancelOrderRequest, options?: RawAxiosRequestConfig) {
|
|
2058
1395
|
return OrdersApiFp(this.configuration).cancelOrder(requestParameters.project, requestParameters.orderId, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
|
|
@@ -2064,7 +1401,6 @@ export class OrdersApi extends BaseAPI {
|
|
|
2064
1401
|
* @param {OrdersApiConfirmOrderRequest} requestParameters Request parameters.
|
|
2065
1402
|
* @param {*} [options] Override http request option.
|
|
2066
1403
|
* @throws {RequiredError}
|
|
2067
|
-
* @memberof OrdersApi
|
|
2068
1404
|
*/
|
|
2069
1405
|
public confirmOrder(requestParameters: OrdersApiConfirmOrderRequest, options?: RawAxiosRequestConfig) {
|
|
2070
1406
|
return OrdersApiFp(this.configuration).confirmOrder(requestParameters.project, requestParameters.orderId, requestParameters.confirmOrderRequest, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
|
|
@@ -2076,7 +1412,6 @@ export class OrdersApi extends BaseAPI {
|
|
|
2076
1412
|
* @param {OrdersApiCreateOrderRequest} requestParameters Request parameters.
|
|
2077
1413
|
* @param {*} [options] Override http request option.
|
|
2078
1414
|
* @throws {RequiredError}
|
|
2079
|
-
* @memberof OrdersApi
|
|
2080
1415
|
*/
|
|
2081
1416
|
public createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: RawAxiosRequestConfig) {
|
|
2082
1417
|
return OrdersApiFp(this.configuration).createOrder(requestParameters.project, requestParameters.createOrder, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
|
|
@@ -2088,7 +1423,6 @@ export class OrdersApi extends BaseAPI {
|
|
|
2088
1423
|
* @param {OrdersApiDownloadInvoiceRequest} requestParameters Request parameters.
|
|
2089
1424
|
* @param {*} [options] Override http request option.
|
|
2090
1425
|
* @throws {RequiredError}
|
|
2091
|
-
* @memberof OrdersApi
|
|
2092
1426
|
*/
|
|
2093
1427
|
public downloadInvoice(requestParameters: OrdersApiDownloadInvoiceRequest, options?: RawAxiosRequestConfig) {
|
|
2094
1428
|
return OrdersApiFp(this.configuration).downloadInvoice(requestParameters.project, requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
@@ -2100,7 +1434,6 @@ export class OrdersApi extends BaseAPI {
|
|
|
2100
1434
|
* @param {OrdersApiExportOrdersRequest} requestParameters Request parameters.
|
|
2101
1435
|
* @param {*} [options] Override http request option.
|
|
2102
1436
|
* @throws {RequiredError}
|
|
2103
|
-
* @memberof OrdersApi
|
|
2104
1437
|
*/
|
|
2105
1438
|
public exportOrders(requestParameters: OrdersApiExportOrdersRequest, options?: RawAxiosRequestConfig) {
|
|
2106
1439
|
return OrdersApiFp(this.configuration).exportOrders(requestParameters.project, requestParameters.start, requestParameters.end, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
@@ -2112,7 +1445,6 @@ export class OrdersApi extends BaseAPI {
|
|
|
2112
1445
|
* @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
|
|
2113
1446
|
* @param {*} [options] Override http request option.
|
|
2114
1447
|
* @throws {RequiredError}
|
|
2115
|
-
* @memberof OrdersApi
|
|
2116
1448
|
*/
|
|
2117
1449
|
public getOrder(requestParameters: OrdersApiGetOrderRequest, options?: RawAxiosRequestConfig) {
|
|
2118
1450
|
return OrdersApiFp(this.configuration).getOrder(requestParameters.project, requestParameters.orderId, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
|
|
@@ -2124,7 +1456,6 @@ export class OrdersApi extends BaseAPI {
|
|
|
2124
1456
|
* @param {OrdersApiGetOrdersRequest} requestParameters Request parameters.
|
|
2125
1457
|
* @param {*} [options] Override http request option.
|
|
2126
1458
|
* @throws {RequiredError}
|
|
2127
|
-
* @memberof OrdersApi
|
|
2128
1459
|
*/
|
|
2129
1460
|
public getOrders(requestParameters: OrdersApiGetOrdersRequest, options?: RawAxiosRequestConfig) {
|
|
2130
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));
|
|
@@ -2136,16 +1467,12 @@ export class OrdersApi extends BaseAPI {
|
|
|
2136
1467
|
* @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
|
|
2137
1468
|
* @param {*} [options] Override http request option.
|
|
2138
1469
|
* @throws {RequiredError}
|
|
2139
|
-
* @memberof OrdersApi
|
|
2140
1470
|
*/
|
|
2141
1471
|
public retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig) {
|
|
2142
1472
|
return OrdersApiFp(this.configuration).retryPlatformPayment(requestParameters.project, requestParameters.orderId, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
|
|
2143
1473
|
}
|
|
2144
1474
|
}
|
|
2145
1475
|
|
|
2146
|
-
/**
|
|
2147
|
-
* @export
|
|
2148
|
-
*/
|
|
2149
1476
|
export const GetOrdersDateFilterTypeEnum = {
|
|
2150
1477
|
CreatedAt: 'createdAt',
|
|
2151
1478
|
UpdatedAt: 'updatedAt',
|