@teemill/platform 0.26.0 → 0.28.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 +12 -2
- package/api.ts +483 -6
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +349 -3
- package/dist/api.js +193 -7
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +349 -3
- package/dist/esm/api.js +192 -6
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- 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 +24 -0
- package/docs/ConfirmOrderFulfillmentShipment.md +21 -0
- package/docs/ConfirmOrderRequest.md +20 -0
- package/docs/CreateOrder.md +33 -0
- package/docs/CreateOrderContactInformation.md +23 -0
- package/docs/CustomsInformation.md +27 -0
- package/docs/OrderItem1.md +24 -0
- package/docs/OrderItem1RecipientCost.md +22 -0
- package/docs/OrdersApi.md +135 -1
- package/index.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @teemill/platform@0.
|
|
1
|
+
## @teemill/platform@0.28.0
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @teemill/platform@0.
|
|
39
|
+
npm install @teemill/platform@0.28.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -59,6 +59,8 @@ Class | Method | HTTP request | Description
|
|
|
59
59
|
*EnquiriesApi* | [**listCustomerEnquiries**](docs/EnquiriesApi.md#listcustomerenquiries) | **GET** /v1/platform/{platformId}/customers/enquiries | List customer enquiries
|
|
60
60
|
*EnquiriesApi* | [**listCustomerEnquiryLogs**](docs/EnquiriesApi.md#listcustomerenquirylogs) | **GET** /v1/platform/{platformId}/customers/enquiries/{enquiryId}/logs | List customer enquiry Logs
|
|
61
61
|
*EnquiriesApi* | [**updateCustomerEnquiry**](docs/EnquiriesApi.md#updatecustomerenquiry) | **PATCH** /v1/platform/{platformId}/customers/enquiries/{enquiryId} | Update customer enquiry
|
|
62
|
+
*OrdersApi* | [**confirmOrder**](docs/OrdersApi.md#confirmorder) | **POST** /v1/platform/{platformId}/orders/{orderId}/confirm | Confirm order
|
|
63
|
+
*OrdersApi* | [**createOrder**](docs/OrdersApi.md#createorder) | **POST** /v1/platform/{platformId}/orders | Create order
|
|
62
64
|
*OrdersApi* | [**exportOrders**](docs/OrdersApi.md#exportorders) | **GET** /v1/platform/{platformId}/orders/export | Export orders
|
|
63
65
|
*OrdersApi* | [**getFulfillment**](docs/OrdersApi.md#getfulfillment) | **GET** /v1/platform/{platformId}/fulfillments/{fulfillmentId} | Get fulfillment
|
|
64
66
|
*OrdersApi* | [**getOrder**](docs/OrdersApi.md#getorder) | **GET** /v1/platform/{platformId}/orders/{orderId} | Get order
|
|
@@ -92,12 +94,18 @@ Class | Method | HTTP request | Description
|
|
|
92
94
|
- [Address](docs/Address.md)
|
|
93
95
|
- [ApiError](docs/ApiError.md)
|
|
94
96
|
- [Client](docs/Client.md)
|
|
97
|
+
- [ConfirmOrderFulfillment](docs/ConfirmOrderFulfillment.md)
|
|
98
|
+
- [ConfirmOrderFulfillmentShipment](docs/ConfirmOrderFulfillmentShipment.md)
|
|
99
|
+
- [ConfirmOrderRequest](docs/ConfirmOrderRequest.md)
|
|
95
100
|
- [ContactInformation](docs/ContactInformation.md)
|
|
96
101
|
- [Coupon](docs/Coupon.md)
|
|
97
102
|
- [CreateChatChannel200Response](docs/CreateChatChannel200Response.md)
|
|
98
103
|
- [CreateDomainRequest](docs/CreateDomainRequest.md)
|
|
104
|
+
- [CreateOrder](docs/CreateOrder.md)
|
|
105
|
+
- [CreateOrderContactInformation](docs/CreateOrderContactInformation.md)
|
|
99
106
|
- [Customer](docs/Customer.md)
|
|
100
107
|
- [CustomersResponse](docs/CustomersResponse.md)
|
|
108
|
+
- [CustomsInformation](docs/CustomsInformation.md)
|
|
101
109
|
- [DeliveryEstimates](docs/DeliveryEstimates.md)
|
|
102
110
|
- [Domain](docs/Domain.md)
|
|
103
111
|
- [Enquiry](docs/Enquiry.md)
|
|
@@ -120,6 +128,8 @@ Class | Method | HTTP request | Description
|
|
|
120
128
|
- [Option](docs/Option.md)
|
|
121
129
|
- [Order](docs/Order.md)
|
|
122
130
|
- [OrderItem](docs/OrderItem.md)
|
|
131
|
+
- [OrderItem1](docs/OrderItem1.md)
|
|
132
|
+
- [OrderItem1RecipientCost](docs/OrderItem1RecipientCost.md)
|
|
123
133
|
- [OrderStatus](docs/OrderStatus.md)
|
|
124
134
|
- [OrderTracking](docs/OrderTracking.md)
|
|
125
135
|
- [OrdersResponse](docs/OrdersResponse.md)
|
package/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Platform API
|
|
5
5
|
* Manage Your podOS platform
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.
|
|
7
|
+
* The version of the OpenAPI document: 0.28.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -122,6 +122,57 @@ export interface Client {
|
|
|
122
122
|
*/
|
|
123
123
|
'name'?: string;
|
|
124
124
|
}
|
|
125
|
+
/**
|
|
126
|
+
*
|
|
127
|
+
* @export
|
|
128
|
+
* @interface ConfirmOrderFulfillment
|
|
129
|
+
*/
|
|
130
|
+
export interface ConfirmOrderFulfillment {
|
|
131
|
+
/**
|
|
132
|
+
* Unique object identifier
|
|
133
|
+
* @type {string}
|
|
134
|
+
* @memberof ConfirmOrderFulfillment
|
|
135
|
+
*/
|
|
136
|
+
'fulfillmentId': string;
|
|
137
|
+
/**
|
|
138
|
+
* Unique object identifier
|
|
139
|
+
* @type {string}
|
|
140
|
+
* @memberof ConfirmOrderFulfillment
|
|
141
|
+
*/
|
|
142
|
+
'shippingMethodId'?: string;
|
|
143
|
+
/**
|
|
144
|
+
*
|
|
145
|
+
* @type {ConfirmOrderFulfillmentShipment}
|
|
146
|
+
* @memberof ConfirmOrderFulfillment
|
|
147
|
+
*/
|
|
148
|
+
'shipment'?: ConfirmOrderFulfillmentShipment;
|
|
149
|
+
}
|
|
150
|
+
/**
|
|
151
|
+
* This field is only required if you are using your own shipping label.
|
|
152
|
+
* @export
|
|
153
|
+
* @interface ConfirmOrderFulfillmentShipment
|
|
154
|
+
*/
|
|
155
|
+
export interface ConfirmOrderFulfillmentShipment {
|
|
156
|
+
/**
|
|
157
|
+
* Only required if you are generating shipping labels outside of PodOS
|
|
158
|
+
* @type {string}
|
|
159
|
+
* @memberof ConfirmOrderFulfillmentShipment
|
|
160
|
+
*/
|
|
161
|
+
'image': string;
|
|
162
|
+
}
|
|
163
|
+
/**
|
|
164
|
+
*
|
|
165
|
+
* @export
|
|
166
|
+
* @interface ConfirmOrderRequest
|
|
167
|
+
*/
|
|
168
|
+
export interface ConfirmOrderRequest {
|
|
169
|
+
/**
|
|
170
|
+
*
|
|
171
|
+
* @type {Array<ConfirmOrderFulfillment>}
|
|
172
|
+
* @memberof ConfirmOrderRequest
|
|
173
|
+
*/
|
|
174
|
+
'fulfillments': Array<ConfirmOrderFulfillment>;
|
|
175
|
+
}
|
|
125
176
|
/**
|
|
126
177
|
* Order recipient contact information, used only for courier tracking/updates.
|
|
127
178
|
* @export
|
|
@@ -186,6 +237,74 @@ export interface CreateDomainRequest {
|
|
|
186
237
|
*/
|
|
187
238
|
'domain'?: string;
|
|
188
239
|
}
|
|
240
|
+
/**
|
|
241
|
+
* Create an order
|
|
242
|
+
* @export
|
|
243
|
+
* @interface CreateOrder
|
|
244
|
+
*/
|
|
245
|
+
export interface CreateOrder {
|
|
246
|
+
/**
|
|
247
|
+
* A custom reference to the merchant\'s order.
|
|
248
|
+
* @type {string}
|
|
249
|
+
* @memberof CreateOrder
|
|
250
|
+
*/
|
|
251
|
+
'merchantReference'?: string | null;
|
|
252
|
+
/**
|
|
253
|
+
*
|
|
254
|
+
* @type {CreateOrderContactInformation}
|
|
255
|
+
* @memberof CreateOrder
|
|
256
|
+
*/
|
|
257
|
+
'contactInformation': CreateOrderContactInformation;
|
|
258
|
+
/**
|
|
259
|
+
*
|
|
260
|
+
* @type {Address}
|
|
261
|
+
* @memberof CreateOrder
|
|
262
|
+
*/
|
|
263
|
+
'shippingAddress': Address;
|
|
264
|
+
/**
|
|
265
|
+
*
|
|
266
|
+
* @type {CustomsInformation}
|
|
267
|
+
* @memberof CreateOrder
|
|
268
|
+
*/
|
|
269
|
+
'customsInformation'?: CustomsInformation;
|
|
270
|
+
/**
|
|
271
|
+
* Items to be ordered
|
|
272
|
+
* @type {Array<OrderItem1>}
|
|
273
|
+
* @memberof CreateOrder
|
|
274
|
+
*/
|
|
275
|
+
'items': Array<OrderItem1>;
|
|
276
|
+
/**
|
|
277
|
+
*
|
|
278
|
+
* @type {Array<string>}
|
|
279
|
+
* @memberof CreateOrder
|
|
280
|
+
*/
|
|
281
|
+
'preferredFulfillers'?: Array<string>;
|
|
282
|
+
/**
|
|
283
|
+
* A reference to the resource location
|
|
284
|
+
* @type {string}
|
|
285
|
+
* @memberof CreateOrder
|
|
286
|
+
*/
|
|
287
|
+
'originalOrderRef'?: string;
|
|
288
|
+
}
|
|
289
|
+
/**
|
|
290
|
+
* Contact information for the order
|
|
291
|
+
* @export
|
|
292
|
+
* @interface CreateOrderContactInformation
|
|
293
|
+
*/
|
|
294
|
+
export interface CreateOrderContactInformation {
|
|
295
|
+
/**
|
|
296
|
+
*
|
|
297
|
+
* @type {string}
|
|
298
|
+
* @memberof CreateOrderContactInformation
|
|
299
|
+
*/
|
|
300
|
+
'email': string;
|
|
301
|
+
/**
|
|
302
|
+
*
|
|
303
|
+
* @type {string}
|
|
304
|
+
* @memberof CreateOrderContactInformation
|
|
305
|
+
*/
|
|
306
|
+
'phone'?: string | null;
|
|
307
|
+
}
|
|
189
308
|
/**
|
|
190
309
|
* The customer that has placed an order on your platform
|
|
191
310
|
* @export
|
|
@@ -254,6 +373,44 @@ export interface CustomersResponse {
|
|
|
254
373
|
*/
|
|
255
374
|
'nextPageToken'?: number | null;
|
|
256
375
|
}
|
|
376
|
+
/**
|
|
377
|
+
* Customs information for the order. **Note:** Adding customs information to an order is only compatible with Shipmate at this time
|
|
378
|
+
* @export
|
|
379
|
+
* @interface CustomsInformation
|
|
380
|
+
*/
|
|
381
|
+
export interface CustomsInformation {
|
|
382
|
+
/**
|
|
383
|
+
* Pre-registration type
|
|
384
|
+
* @type {string}
|
|
385
|
+
* @memberof CustomsInformation
|
|
386
|
+
*/
|
|
387
|
+
'preRegistrationType'?: CustomsInformationPreRegistrationTypeEnum;
|
|
388
|
+
/**
|
|
389
|
+
* Pre-registration number
|
|
390
|
+
* @type {string}
|
|
391
|
+
* @memberof CustomsInformation
|
|
392
|
+
*/
|
|
393
|
+
'preRegistrationNumber'?: string;
|
|
394
|
+
/**
|
|
395
|
+
* VAT number
|
|
396
|
+
* @type {string}
|
|
397
|
+
* @memberof CustomsInformation
|
|
398
|
+
*/
|
|
399
|
+
'vatNumber'?: string;
|
|
400
|
+
/**
|
|
401
|
+
* EORI number
|
|
402
|
+
* @type {string}
|
|
403
|
+
* @memberof CustomsInformation
|
|
404
|
+
*/
|
|
405
|
+
'eoriNumber'?: string;
|
|
406
|
+
}
|
|
407
|
+
|
|
408
|
+
export const CustomsInformationPreRegistrationTypeEnum = {
|
|
409
|
+
Ioss: 'IOSS'
|
|
410
|
+
} as const;
|
|
411
|
+
|
|
412
|
+
export type CustomsInformationPreRegistrationTypeEnum = typeof CustomsInformationPreRegistrationTypeEnum[keyof typeof CustomsInformationPreRegistrationTypeEnum];
|
|
413
|
+
|
|
257
414
|
/**
|
|
258
415
|
*
|
|
259
416
|
* @export
|
|
@@ -985,6 +1142,50 @@ export interface OrderItem {
|
|
|
985
1142
|
*/
|
|
986
1143
|
'recipientCost'?: Price;
|
|
987
1144
|
}
|
|
1145
|
+
/**
|
|
1146
|
+
*
|
|
1147
|
+
* @export
|
|
1148
|
+
* @interface OrderItem1
|
|
1149
|
+
*/
|
|
1150
|
+
export interface OrderItem1 {
|
|
1151
|
+
/**
|
|
1152
|
+
* A reference to the variant being ordered
|
|
1153
|
+
* @type {string}
|
|
1154
|
+
* @memberof OrderItem1
|
|
1155
|
+
*/
|
|
1156
|
+
'variantRef': string;
|
|
1157
|
+
/**
|
|
1158
|
+
*
|
|
1159
|
+
* @type {number}
|
|
1160
|
+
* @memberof OrderItem1
|
|
1161
|
+
*/
|
|
1162
|
+
'quantity': number;
|
|
1163
|
+
/**
|
|
1164
|
+
*
|
|
1165
|
+
* @type {OrderItem1RecipientCost}
|
|
1166
|
+
* @memberof OrderItem1
|
|
1167
|
+
*/
|
|
1168
|
+
'recipientCost'?: OrderItem1RecipientCost;
|
|
1169
|
+
}
|
|
1170
|
+
/**
|
|
1171
|
+
*
|
|
1172
|
+
* @export
|
|
1173
|
+
* @interface OrderItem1RecipientCost
|
|
1174
|
+
*/
|
|
1175
|
+
export interface OrderItem1RecipientCost {
|
|
1176
|
+
/**
|
|
1177
|
+
*
|
|
1178
|
+
* @type {string}
|
|
1179
|
+
* @memberof OrderItem1RecipientCost
|
|
1180
|
+
*/
|
|
1181
|
+
'amount': string;
|
|
1182
|
+
/**
|
|
1183
|
+
*
|
|
1184
|
+
* @type {string}
|
|
1185
|
+
* @memberof OrderItem1RecipientCost
|
|
1186
|
+
*/
|
|
1187
|
+
'currencyCode': string;
|
|
1188
|
+
}
|
|
988
1189
|
/**
|
|
989
1190
|
*
|
|
990
1191
|
* @export
|
|
@@ -3125,6 +3326,118 @@ export class EnquiriesApi extends BaseAPI {
|
|
|
3125
3326
|
*/
|
|
3126
3327
|
export const OrdersApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
3127
3328
|
return {
|
|
3329
|
+
/**
|
|
3330
|
+
*
|
|
3331
|
+
* @summary Confirm order
|
|
3332
|
+
* @param {string} project Project unique identifier
|
|
3333
|
+
* @param {string} platformId The platform identifier
|
|
3334
|
+
* @param {string} orderId The order identifier
|
|
3335
|
+
* @param {ConfirmOrderRequest} confirmOrderRequest ConfirmFulfillment schema
|
|
3336
|
+
* @param {*} [options] Override http request option.
|
|
3337
|
+
* @throws {RequiredError}
|
|
3338
|
+
*/
|
|
3339
|
+
confirmOrder: async (project: string, platformId: string, orderId: string, confirmOrderRequest: ConfirmOrderRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3340
|
+
// verify required parameter 'project' is not null or undefined
|
|
3341
|
+
assertParamExists('confirmOrder', 'project', project)
|
|
3342
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
3343
|
+
assertParamExists('confirmOrder', 'platformId', platformId)
|
|
3344
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
3345
|
+
assertParamExists('confirmOrder', 'orderId', orderId)
|
|
3346
|
+
// verify required parameter 'confirmOrderRequest' is not null or undefined
|
|
3347
|
+
assertParamExists('confirmOrder', 'confirmOrderRequest', confirmOrderRequest)
|
|
3348
|
+
const localVarPath = `/v1/platform/{platformId}/orders/{orderId}/confirm`
|
|
3349
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
3350
|
+
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
|
|
3351
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3352
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3353
|
+
let baseOptions;
|
|
3354
|
+
if (configuration) {
|
|
3355
|
+
baseOptions = configuration.baseOptions;
|
|
3356
|
+
}
|
|
3357
|
+
|
|
3358
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
3359
|
+
const localVarHeaderParameter = {} as any;
|
|
3360
|
+
const localVarQueryParameter = {} as any;
|
|
3361
|
+
|
|
3362
|
+
// authentication session-oauth required
|
|
3363
|
+
// oauth required
|
|
3364
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
3365
|
+
|
|
3366
|
+
// authentication api-key required
|
|
3367
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3368
|
+
|
|
3369
|
+
if (project !== undefined) {
|
|
3370
|
+
localVarQueryParameter['project'] = project;
|
|
3371
|
+
}
|
|
3372
|
+
|
|
3373
|
+
|
|
3374
|
+
|
|
3375
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
3376
|
+
|
|
3377
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3378
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3379
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3380
|
+
localVarRequestOptions.data = serializeDataIfNeeded(confirmOrderRequest, localVarRequestOptions, configuration)
|
|
3381
|
+
|
|
3382
|
+
return {
|
|
3383
|
+
url: toPathString(localVarUrlObj),
|
|
3384
|
+
options: localVarRequestOptions,
|
|
3385
|
+
};
|
|
3386
|
+
},
|
|
3387
|
+
/**
|
|
3388
|
+
*
|
|
3389
|
+
* @summary Create order
|
|
3390
|
+
* @param {string} project Project unique identifier
|
|
3391
|
+
* @param {string} platformId The platform identifier
|
|
3392
|
+
* @param {CreateOrder} createOrder Create Order schema
|
|
3393
|
+
* @param {*} [options] Override http request option.
|
|
3394
|
+
* @throws {RequiredError}
|
|
3395
|
+
*/
|
|
3396
|
+
createOrder: async (project: string, platformId: string, createOrder: CreateOrder, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3397
|
+
// verify required parameter 'project' is not null or undefined
|
|
3398
|
+
assertParamExists('createOrder', 'project', project)
|
|
3399
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
3400
|
+
assertParamExists('createOrder', 'platformId', platformId)
|
|
3401
|
+
// verify required parameter 'createOrder' is not null or undefined
|
|
3402
|
+
assertParamExists('createOrder', 'createOrder', createOrder)
|
|
3403
|
+
const localVarPath = `/v1/platform/{platformId}/orders`
|
|
3404
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
3405
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3406
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3407
|
+
let baseOptions;
|
|
3408
|
+
if (configuration) {
|
|
3409
|
+
baseOptions = configuration.baseOptions;
|
|
3410
|
+
}
|
|
3411
|
+
|
|
3412
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
3413
|
+
const localVarHeaderParameter = {} as any;
|
|
3414
|
+
const localVarQueryParameter = {} as any;
|
|
3415
|
+
|
|
3416
|
+
// authentication session-oauth required
|
|
3417
|
+
// oauth required
|
|
3418
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
3419
|
+
|
|
3420
|
+
// authentication api-key required
|
|
3421
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3422
|
+
|
|
3423
|
+
if (project !== undefined) {
|
|
3424
|
+
localVarQueryParameter['project'] = project;
|
|
3425
|
+
}
|
|
3426
|
+
|
|
3427
|
+
|
|
3428
|
+
|
|
3429
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
3430
|
+
|
|
3431
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3432
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3433
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3434
|
+
localVarRequestOptions.data = serializeDataIfNeeded(createOrder, localVarRequestOptions, configuration)
|
|
3435
|
+
|
|
3436
|
+
return {
|
|
3437
|
+
url: toPathString(localVarUrlObj),
|
|
3438
|
+
options: localVarRequestOptions,
|
|
3439
|
+
};
|
|
3440
|
+
},
|
|
3128
3441
|
/**
|
|
3129
3442
|
* Export orders as a CSV file
|
|
3130
3443
|
* @summary Export orders
|
|
@@ -3413,10 +3726,12 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
3413
3726
|
* @param {string} [start] Start of date range to filter when orders were placed
|
|
3414
3727
|
* @param {string} [end] End of date range to filter when orders were placed
|
|
3415
3728
|
* @param {ListOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
3729
|
+
* @param {number} [maxOrderTotal] The maximum value of the order
|
|
3730
|
+
* @param {number} [minOrderTotal] The minimum value of the order
|
|
3416
3731
|
* @param {*} [options] Override http request option.
|
|
3417
3732
|
* @throws {RequiredError}
|
|
3418
3733
|
*/
|
|
3419
|
-
listOrders: async (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, dateFilterType?: ListOrdersDateFilterTypeEnum, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3734
|
+
listOrders: async (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, dateFilterType?: ListOrdersDateFilterTypeEnum, maxOrderTotal?: number, minOrderTotal?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3420
3735
|
// verify required parameter 'project' is not null or undefined
|
|
3421
3736
|
assertParamExists('listOrders', 'project', project)
|
|
3422
3737
|
// verify required parameter 'platformId' is not null or undefined
|
|
@@ -3473,6 +3788,14 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
3473
3788
|
localVarQueryParameter['dateFilterType'] = dateFilterType;
|
|
3474
3789
|
}
|
|
3475
3790
|
|
|
3791
|
+
if (maxOrderTotal !== undefined) {
|
|
3792
|
+
localVarQueryParameter['maxOrderTotal'] = maxOrderTotal;
|
|
3793
|
+
}
|
|
3794
|
+
|
|
3795
|
+
if (minOrderTotal !== undefined) {
|
|
3796
|
+
localVarQueryParameter['minOrderTotal'] = minOrderTotal;
|
|
3797
|
+
}
|
|
3798
|
+
|
|
3476
3799
|
|
|
3477
3800
|
|
|
3478
3801
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -3656,6 +3979,37 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
3656
3979
|
export const OrdersApiFp = function(configuration?: Configuration) {
|
|
3657
3980
|
const localVarAxiosParamCreator = OrdersApiAxiosParamCreator(configuration)
|
|
3658
3981
|
return {
|
|
3982
|
+
/**
|
|
3983
|
+
*
|
|
3984
|
+
* @summary Confirm order
|
|
3985
|
+
* @param {string} project Project unique identifier
|
|
3986
|
+
* @param {string} platformId The platform identifier
|
|
3987
|
+
* @param {string} orderId The order identifier
|
|
3988
|
+
* @param {ConfirmOrderRequest} confirmOrderRequest ConfirmFulfillment schema
|
|
3989
|
+
* @param {*} [options] Override http request option.
|
|
3990
|
+
* @throws {RequiredError}
|
|
3991
|
+
*/
|
|
3992
|
+
async confirmOrder(project: string, platformId: string, orderId: string, confirmOrderRequest: ConfirmOrderRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>> {
|
|
3993
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.confirmOrder(project, platformId, orderId, confirmOrderRequest, options);
|
|
3994
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3995
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.confirmOrder']?.[localVarOperationServerIndex]?.url;
|
|
3996
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3997
|
+
},
|
|
3998
|
+
/**
|
|
3999
|
+
*
|
|
4000
|
+
* @summary Create order
|
|
4001
|
+
* @param {string} project Project unique identifier
|
|
4002
|
+
* @param {string} platformId The platform identifier
|
|
4003
|
+
* @param {CreateOrder} createOrder Create Order schema
|
|
4004
|
+
* @param {*} [options] Override http request option.
|
|
4005
|
+
* @throws {RequiredError}
|
|
4006
|
+
*/
|
|
4007
|
+
async createOrder(project: string, platformId: string, createOrder: CreateOrder, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>> {
|
|
4008
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createOrder(project, platformId, createOrder, options);
|
|
4009
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
4010
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.createOrder']?.[localVarOperationServerIndex]?.url;
|
|
4011
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4012
|
+
},
|
|
3659
4013
|
/**
|
|
3660
4014
|
* Export orders as a CSV file
|
|
3661
4015
|
* @summary Export orders
|
|
@@ -3744,11 +4098,13 @@ export const OrdersApiFp = function(configuration?: Configuration) {
|
|
|
3744
4098
|
* @param {string} [start] Start of date range to filter when orders were placed
|
|
3745
4099
|
* @param {string} [end] End of date range to filter when orders were placed
|
|
3746
4100
|
* @param {ListOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
4101
|
+
* @param {number} [maxOrderTotal] The maximum value of the order
|
|
4102
|
+
* @param {number} [minOrderTotal] The minimum value of the order
|
|
3747
4103
|
* @param {*} [options] Override http request option.
|
|
3748
4104
|
* @throws {RequiredError}
|
|
3749
4105
|
*/
|
|
3750
|
-
async listOrders(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, dateFilterType?: ListOrdersDateFilterTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrdersResponse>> {
|
|
3751
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listOrders(project, platformId, pageToken, pageSize, search, start, end, dateFilterType, options);
|
|
4106
|
+
async listOrders(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, dateFilterType?: ListOrdersDateFilterTypeEnum, maxOrderTotal?: number, minOrderTotal?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrdersResponse>> {
|
|
4107
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listOrders(project, platformId, pageToken, pageSize, search, start, end, dateFilterType, maxOrderTotal, minOrderTotal, options);
|
|
3752
4108
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3753
4109
|
const localVarOperationServerBasePath = operationServerMap['OrdersApi.listOrders']?.[localVarOperationServerIndex]?.url;
|
|
3754
4110
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -3809,6 +4165,26 @@ export const OrdersApiFp = function(configuration?: Configuration) {
|
|
|
3809
4165
|
export const OrdersApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
3810
4166
|
const localVarFp = OrdersApiFp(configuration)
|
|
3811
4167
|
return {
|
|
4168
|
+
/**
|
|
4169
|
+
*
|
|
4170
|
+
* @summary Confirm order
|
|
4171
|
+
* @param {OrdersApiConfirmOrderRequest} requestParameters Request parameters.
|
|
4172
|
+
* @param {*} [options] Override http request option.
|
|
4173
|
+
* @throws {RequiredError}
|
|
4174
|
+
*/
|
|
4175
|
+
confirmOrder(requestParameters: OrdersApiConfirmOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order> {
|
|
4176
|
+
return localVarFp.confirmOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, requestParameters.confirmOrderRequest, options).then((request) => request(axios, basePath));
|
|
4177
|
+
},
|
|
4178
|
+
/**
|
|
4179
|
+
*
|
|
4180
|
+
* @summary Create order
|
|
4181
|
+
* @param {OrdersApiCreateOrderRequest} requestParameters Request parameters.
|
|
4182
|
+
* @param {*} [options] Override http request option.
|
|
4183
|
+
* @throws {RequiredError}
|
|
4184
|
+
*/
|
|
4185
|
+
createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order> {
|
|
4186
|
+
return localVarFp.createOrder(requestParameters.project, requestParameters.platformId, requestParameters.createOrder, options).then((request) => request(axios, basePath));
|
|
4187
|
+
},
|
|
3812
4188
|
/**
|
|
3813
4189
|
* Export orders as a CSV file
|
|
3814
4190
|
* @summary Export orders
|
|
@@ -3867,7 +4243,7 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
|
|
|
3867
4243
|
* @throws {RequiredError}
|
|
3868
4244
|
*/
|
|
3869
4245
|
listOrders(requestParameters: OrdersApiListOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrdersResponse> {
|
|
3870
|
-
return localVarFp.listOrders(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, options).then((request) => request(axios, basePath));
|
|
4246
|
+
return localVarFp.listOrders(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxOrderTotal, requestParameters.minOrderTotal, options).then((request) => request(axios, basePath));
|
|
3871
4247
|
},
|
|
3872
4248
|
/**
|
|
3873
4249
|
* Retries failed platform payment, so fulfillment can proceed.
|
|
@@ -3902,6 +4278,69 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
|
|
|
3902
4278
|
};
|
|
3903
4279
|
};
|
|
3904
4280
|
|
|
4281
|
+
/**
|
|
4282
|
+
* Request parameters for confirmOrder operation in OrdersApi.
|
|
4283
|
+
* @export
|
|
4284
|
+
* @interface OrdersApiConfirmOrderRequest
|
|
4285
|
+
*/
|
|
4286
|
+
export interface OrdersApiConfirmOrderRequest {
|
|
4287
|
+
/**
|
|
4288
|
+
* Project unique identifier
|
|
4289
|
+
* @type {string}
|
|
4290
|
+
* @memberof OrdersApiConfirmOrder
|
|
4291
|
+
*/
|
|
4292
|
+
readonly project: string
|
|
4293
|
+
|
|
4294
|
+
/**
|
|
4295
|
+
* The platform identifier
|
|
4296
|
+
* @type {string}
|
|
4297
|
+
* @memberof OrdersApiConfirmOrder
|
|
4298
|
+
*/
|
|
4299
|
+
readonly platformId: string
|
|
4300
|
+
|
|
4301
|
+
/**
|
|
4302
|
+
* The order identifier
|
|
4303
|
+
* @type {string}
|
|
4304
|
+
* @memberof OrdersApiConfirmOrder
|
|
4305
|
+
*/
|
|
4306
|
+
readonly orderId: string
|
|
4307
|
+
|
|
4308
|
+
/**
|
|
4309
|
+
* ConfirmFulfillment schema
|
|
4310
|
+
* @type {ConfirmOrderRequest}
|
|
4311
|
+
* @memberof OrdersApiConfirmOrder
|
|
4312
|
+
*/
|
|
4313
|
+
readonly confirmOrderRequest: ConfirmOrderRequest
|
|
4314
|
+
}
|
|
4315
|
+
|
|
4316
|
+
/**
|
|
4317
|
+
* Request parameters for createOrder operation in OrdersApi.
|
|
4318
|
+
* @export
|
|
4319
|
+
* @interface OrdersApiCreateOrderRequest
|
|
4320
|
+
*/
|
|
4321
|
+
export interface OrdersApiCreateOrderRequest {
|
|
4322
|
+
/**
|
|
4323
|
+
* Project unique identifier
|
|
4324
|
+
* @type {string}
|
|
4325
|
+
* @memberof OrdersApiCreateOrder
|
|
4326
|
+
*/
|
|
4327
|
+
readonly project: string
|
|
4328
|
+
|
|
4329
|
+
/**
|
|
4330
|
+
* The platform identifier
|
|
4331
|
+
* @type {string}
|
|
4332
|
+
* @memberof OrdersApiCreateOrder
|
|
4333
|
+
*/
|
|
4334
|
+
readonly platformId: string
|
|
4335
|
+
|
|
4336
|
+
/**
|
|
4337
|
+
* Create Order schema
|
|
4338
|
+
* @type {CreateOrder}
|
|
4339
|
+
* @memberof OrdersApiCreateOrder
|
|
4340
|
+
*/
|
|
4341
|
+
readonly createOrder: CreateOrder
|
|
4342
|
+
}
|
|
4343
|
+
|
|
3905
4344
|
/**
|
|
3906
4345
|
* Request parameters for exportOrders operation in OrdersApi.
|
|
3907
4346
|
* @export
|
|
@@ -4117,6 +4556,20 @@ export interface OrdersApiListOrdersRequest {
|
|
|
4117
4556
|
* @memberof OrdersApiListOrders
|
|
4118
4557
|
*/
|
|
4119
4558
|
readonly dateFilterType?: ListOrdersDateFilterTypeEnum
|
|
4559
|
+
|
|
4560
|
+
/**
|
|
4561
|
+
* The maximum value of the order
|
|
4562
|
+
* @type {number}
|
|
4563
|
+
* @memberof OrdersApiListOrders
|
|
4564
|
+
*/
|
|
4565
|
+
readonly maxOrderTotal?: number
|
|
4566
|
+
|
|
4567
|
+
/**
|
|
4568
|
+
* The minimum value of the order
|
|
4569
|
+
* @type {number}
|
|
4570
|
+
* @memberof OrdersApiListOrders
|
|
4571
|
+
*/
|
|
4572
|
+
readonly minOrderTotal?: number
|
|
4120
4573
|
}
|
|
4121
4574
|
|
|
4122
4575
|
/**
|
|
@@ -4217,6 +4670,30 @@ export interface OrdersApiUpdateFulfillmentRequest {
|
|
|
4217
4670
|
* @extends {BaseAPI}
|
|
4218
4671
|
*/
|
|
4219
4672
|
export class OrdersApi extends BaseAPI {
|
|
4673
|
+
/**
|
|
4674
|
+
*
|
|
4675
|
+
* @summary Confirm order
|
|
4676
|
+
* @param {OrdersApiConfirmOrderRequest} requestParameters Request parameters.
|
|
4677
|
+
* @param {*} [options] Override http request option.
|
|
4678
|
+
* @throws {RequiredError}
|
|
4679
|
+
* @memberof OrdersApi
|
|
4680
|
+
*/
|
|
4681
|
+
public confirmOrder(requestParameters: OrdersApiConfirmOrderRequest, options?: RawAxiosRequestConfig) {
|
|
4682
|
+
return OrdersApiFp(this.configuration).confirmOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, requestParameters.confirmOrderRequest, options).then((request) => request(this.axios, this.basePath));
|
|
4683
|
+
}
|
|
4684
|
+
|
|
4685
|
+
/**
|
|
4686
|
+
*
|
|
4687
|
+
* @summary Create order
|
|
4688
|
+
* @param {OrdersApiCreateOrderRequest} requestParameters Request parameters.
|
|
4689
|
+
* @param {*} [options] Override http request option.
|
|
4690
|
+
* @throws {RequiredError}
|
|
4691
|
+
* @memberof OrdersApi
|
|
4692
|
+
*/
|
|
4693
|
+
public createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: RawAxiosRequestConfig) {
|
|
4694
|
+
return OrdersApiFp(this.configuration).createOrder(requestParameters.project, requestParameters.platformId, requestParameters.createOrder, options).then((request) => request(this.axios, this.basePath));
|
|
4695
|
+
}
|
|
4696
|
+
|
|
4220
4697
|
/**
|
|
4221
4698
|
* Export orders as a CSV file
|
|
4222
4699
|
* @summary Export orders
|
|
@@ -4286,7 +4763,7 @@ export class OrdersApi extends BaseAPI {
|
|
|
4286
4763
|
* @memberof OrdersApi
|
|
4287
4764
|
*/
|
|
4288
4765
|
public listOrders(requestParameters: OrdersApiListOrdersRequest, options?: RawAxiosRequestConfig) {
|
|
4289
|
-
return OrdersApiFp(this.configuration).listOrders(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, options).then((request) => request(this.axios, this.basePath));
|
|
4766
|
+
return OrdersApiFp(this.configuration).listOrders(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxOrderTotal, requestParameters.minOrderTotal, options).then((request) => request(this.axios, this.basePath));
|
|
4290
4767
|
}
|
|
4291
4768
|
|
|
4292
4769
|
/**
|
package/base.ts
CHANGED
package/common.ts
CHANGED
package/configuration.ts
CHANGED