@teemill/platform 0.27.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 +452 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +331 -1
- package/dist/api.js +178 -2
- 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 +331 -1
- package/dist/esm/api.js +177 -1
- 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 +128 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/esm/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Platform API
|
|
3
3
|
* Manage Your podOS platform
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.
|
|
5
|
+
* The version of the OpenAPI document: 0.28.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -112,6 +112,57 @@ export interface Client {
|
|
|
112
112
|
*/
|
|
113
113
|
'name'?: string;
|
|
114
114
|
}
|
|
115
|
+
/**
|
|
116
|
+
*
|
|
117
|
+
* @export
|
|
118
|
+
* @interface ConfirmOrderFulfillment
|
|
119
|
+
*/
|
|
120
|
+
export interface ConfirmOrderFulfillment {
|
|
121
|
+
/**
|
|
122
|
+
* Unique object identifier
|
|
123
|
+
* @type {string}
|
|
124
|
+
* @memberof ConfirmOrderFulfillment
|
|
125
|
+
*/
|
|
126
|
+
'fulfillmentId': string;
|
|
127
|
+
/**
|
|
128
|
+
* Unique object identifier
|
|
129
|
+
* @type {string}
|
|
130
|
+
* @memberof ConfirmOrderFulfillment
|
|
131
|
+
*/
|
|
132
|
+
'shippingMethodId'?: string;
|
|
133
|
+
/**
|
|
134
|
+
*
|
|
135
|
+
* @type {ConfirmOrderFulfillmentShipment}
|
|
136
|
+
* @memberof ConfirmOrderFulfillment
|
|
137
|
+
*/
|
|
138
|
+
'shipment'?: ConfirmOrderFulfillmentShipment;
|
|
139
|
+
}
|
|
140
|
+
/**
|
|
141
|
+
* This field is only required if you are using your own shipping label.
|
|
142
|
+
* @export
|
|
143
|
+
* @interface ConfirmOrderFulfillmentShipment
|
|
144
|
+
*/
|
|
145
|
+
export interface ConfirmOrderFulfillmentShipment {
|
|
146
|
+
/**
|
|
147
|
+
* Only required if you are generating shipping labels outside of PodOS
|
|
148
|
+
* @type {string}
|
|
149
|
+
* @memberof ConfirmOrderFulfillmentShipment
|
|
150
|
+
*/
|
|
151
|
+
'image': string;
|
|
152
|
+
}
|
|
153
|
+
/**
|
|
154
|
+
*
|
|
155
|
+
* @export
|
|
156
|
+
* @interface ConfirmOrderRequest
|
|
157
|
+
*/
|
|
158
|
+
export interface ConfirmOrderRequest {
|
|
159
|
+
/**
|
|
160
|
+
*
|
|
161
|
+
* @type {Array<ConfirmOrderFulfillment>}
|
|
162
|
+
* @memberof ConfirmOrderRequest
|
|
163
|
+
*/
|
|
164
|
+
'fulfillments': Array<ConfirmOrderFulfillment>;
|
|
165
|
+
}
|
|
115
166
|
/**
|
|
116
167
|
* Order recipient contact information, used only for courier tracking/updates.
|
|
117
168
|
* @export
|
|
@@ -176,6 +227,74 @@ export interface CreateDomainRequest {
|
|
|
176
227
|
*/
|
|
177
228
|
'domain'?: string;
|
|
178
229
|
}
|
|
230
|
+
/**
|
|
231
|
+
* Create an order
|
|
232
|
+
* @export
|
|
233
|
+
* @interface CreateOrder
|
|
234
|
+
*/
|
|
235
|
+
export interface CreateOrder {
|
|
236
|
+
/**
|
|
237
|
+
* A custom reference to the merchant\'s order.
|
|
238
|
+
* @type {string}
|
|
239
|
+
* @memberof CreateOrder
|
|
240
|
+
*/
|
|
241
|
+
'merchantReference'?: string | null;
|
|
242
|
+
/**
|
|
243
|
+
*
|
|
244
|
+
* @type {CreateOrderContactInformation}
|
|
245
|
+
* @memberof CreateOrder
|
|
246
|
+
*/
|
|
247
|
+
'contactInformation': CreateOrderContactInformation;
|
|
248
|
+
/**
|
|
249
|
+
*
|
|
250
|
+
* @type {Address}
|
|
251
|
+
* @memberof CreateOrder
|
|
252
|
+
*/
|
|
253
|
+
'shippingAddress': Address;
|
|
254
|
+
/**
|
|
255
|
+
*
|
|
256
|
+
* @type {CustomsInformation}
|
|
257
|
+
* @memberof CreateOrder
|
|
258
|
+
*/
|
|
259
|
+
'customsInformation'?: CustomsInformation;
|
|
260
|
+
/**
|
|
261
|
+
* Items to be ordered
|
|
262
|
+
* @type {Array<OrderItem1>}
|
|
263
|
+
* @memberof CreateOrder
|
|
264
|
+
*/
|
|
265
|
+
'items': Array<OrderItem1>;
|
|
266
|
+
/**
|
|
267
|
+
*
|
|
268
|
+
* @type {Array<string>}
|
|
269
|
+
* @memberof CreateOrder
|
|
270
|
+
*/
|
|
271
|
+
'preferredFulfillers'?: Array<string>;
|
|
272
|
+
/**
|
|
273
|
+
* A reference to the resource location
|
|
274
|
+
* @type {string}
|
|
275
|
+
* @memberof CreateOrder
|
|
276
|
+
*/
|
|
277
|
+
'originalOrderRef'?: string;
|
|
278
|
+
}
|
|
279
|
+
/**
|
|
280
|
+
* Contact information for the order
|
|
281
|
+
* @export
|
|
282
|
+
* @interface CreateOrderContactInformation
|
|
283
|
+
*/
|
|
284
|
+
export interface CreateOrderContactInformation {
|
|
285
|
+
/**
|
|
286
|
+
*
|
|
287
|
+
* @type {string}
|
|
288
|
+
* @memberof CreateOrderContactInformation
|
|
289
|
+
*/
|
|
290
|
+
'email': string;
|
|
291
|
+
/**
|
|
292
|
+
*
|
|
293
|
+
* @type {string}
|
|
294
|
+
* @memberof CreateOrderContactInformation
|
|
295
|
+
*/
|
|
296
|
+
'phone'?: string | null;
|
|
297
|
+
}
|
|
179
298
|
/**
|
|
180
299
|
* The customer that has placed an order on your platform
|
|
181
300
|
* @export
|
|
@@ -244,6 +363,41 @@ export interface CustomersResponse {
|
|
|
244
363
|
*/
|
|
245
364
|
'nextPageToken'?: number | null;
|
|
246
365
|
}
|
|
366
|
+
/**
|
|
367
|
+
* Customs information for the order. **Note:** Adding customs information to an order is only compatible with Shipmate at this time
|
|
368
|
+
* @export
|
|
369
|
+
* @interface CustomsInformation
|
|
370
|
+
*/
|
|
371
|
+
export interface CustomsInformation {
|
|
372
|
+
/**
|
|
373
|
+
* Pre-registration type
|
|
374
|
+
* @type {string}
|
|
375
|
+
* @memberof CustomsInformation
|
|
376
|
+
*/
|
|
377
|
+
'preRegistrationType'?: CustomsInformationPreRegistrationTypeEnum;
|
|
378
|
+
/**
|
|
379
|
+
* Pre-registration number
|
|
380
|
+
* @type {string}
|
|
381
|
+
* @memberof CustomsInformation
|
|
382
|
+
*/
|
|
383
|
+
'preRegistrationNumber'?: string;
|
|
384
|
+
/**
|
|
385
|
+
* VAT number
|
|
386
|
+
* @type {string}
|
|
387
|
+
* @memberof CustomsInformation
|
|
388
|
+
*/
|
|
389
|
+
'vatNumber'?: string;
|
|
390
|
+
/**
|
|
391
|
+
* EORI number
|
|
392
|
+
* @type {string}
|
|
393
|
+
* @memberof CustomsInformation
|
|
394
|
+
*/
|
|
395
|
+
'eoriNumber'?: string;
|
|
396
|
+
}
|
|
397
|
+
export declare const CustomsInformationPreRegistrationTypeEnum: {
|
|
398
|
+
readonly Ioss: "IOSS";
|
|
399
|
+
};
|
|
400
|
+
export type CustomsInformationPreRegistrationTypeEnum = typeof CustomsInformationPreRegistrationTypeEnum[keyof typeof CustomsInformationPreRegistrationTypeEnum];
|
|
247
401
|
/**
|
|
248
402
|
*
|
|
249
403
|
* @export
|
|
@@ -967,6 +1121,50 @@ export interface OrderItem {
|
|
|
967
1121
|
*/
|
|
968
1122
|
'recipientCost'?: Price;
|
|
969
1123
|
}
|
|
1124
|
+
/**
|
|
1125
|
+
*
|
|
1126
|
+
* @export
|
|
1127
|
+
* @interface OrderItem1
|
|
1128
|
+
*/
|
|
1129
|
+
export interface OrderItem1 {
|
|
1130
|
+
/**
|
|
1131
|
+
* A reference to the variant being ordered
|
|
1132
|
+
* @type {string}
|
|
1133
|
+
* @memberof OrderItem1
|
|
1134
|
+
*/
|
|
1135
|
+
'variantRef': string;
|
|
1136
|
+
/**
|
|
1137
|
+
*
|
|
1138
|
+
* @type {number}
|
|
1139
|
+
* @memberof OrderItem1
|
|
1140
|
+
*/
|
|
1141
|
+
'quantity': number;
|
|
1142
|
+
/**
|
|
1143
|
+
*
|
|
1144
|
+
* @type {OrderItem1RecipientCost}
|
|
1145
|
+
* @memberof OrderItem1
|
|
1146
|
+
*/
|
|
1147
|
+
'recipientCost'?: OrderItem1RecipientCost;
|
|
1148
|
+
}
|
|
1149
|
+
/**
|
|
1150
|
+
*
|
|
1151
|
+
* @export
|
|
1152
|
+
* @interface OrderItem1RecipientCost
|
|
1153
|
+
*/
|
|
1154
|
+
export interface OrderItem1RecipientCost {
|
|
1155
|
+
/**
|
|
1156
|
+
*
|
|
1157
|
+
* @type {string}
|
|
1158
|
+
* @memberof OrderItem1RecipientCost
|
|
1159
|
+
*/
|
|
1160
|
+
'amount': string;
|
|
1161
|
+
/**
|
|
1162
|
+
*
|
|
1163
|
+
* @type {string}
|
|
1164
|
+
* @memberof OrderItem1RecipientCost
|
|
1165
|
+
*/
|
|
1166
|
+
'currencyCode': string;
|
|
1167
|
+
}
|
|
970
1168
|
/**
|
|
971
1169
|
*
|
|
972
1170
|
* @export
|
|
@@ -2508,6 +2706,27 @@ export declare class EnquiriesApi extends BaseAPI {
|
|
|
2508
2706
|
* @export
|
|
2509
2707
|
*/
|
|
2510
2708
|
export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2709
|
+
/**
|
|
2710
|
+
*
|
|
2711
|
+
* @summary Confirm order
|
|
2712
|
+
* @param {string} project Project unique identifier
|
|
2713
|
+
* @param {string} platformId The platform identifier
|
|
2714
|
+
* @param {string} orderId The order identifier
|
|
2715
|
+
* @param {ConfirmOrderRequest} confirmOrderRequest ConfirmFulfillment schema
|
|
2716
|
+
* @param {*} [options] Override http request option.
|
|
2717
|
+
* @throws {RequiredError}
|
|
2718
|
+
*/
|
|
2719
|
+
confirmOrder: (project: string, platformId: string, orderId: string, confirmOrderRequest: ConfirmOrderRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2720
|
+
/**
|
|
2721
|
+
*
|
|
2722
|
+
* @summary Create order
|
|
2723
|
+
* @param {string} project Project unique identifier
|
|
2724
|
+
* @param {string} platformId The platform identifier
|
|
2725
|
+
* @param {CreateOrder} createOrder Create Order schema
|
|
2726
|
+
* @param {*} [options] Override http request option.
|
|
2727
|
+
* @throws {RequiredError}
|
|
2728
|
+
*/
|
|
2729
|
+
createOrder: (project: string, platformId: string, createOrder: CreateOrder, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2511
2730
|
/**
|
|
2512
2731
|
* Export orders as a CSV file
|
|
2513
2732
|
* @summary Export orders
|
|
@@ -2614,6 +2833,27 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
2614
2833
|
* @export
|
|
2615
2834
|
*/
|
|
2616
2835
|
export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
2836
|
+
/**
|
|
2837
|
+
*
|
|
2838
|
+
* @summary Confirm order
|
|
2839
|
+
* @param {string} project Project unique identifier
|
|
2840
|
+
* @param {string} platformId The platform identifier
|
|
2841
|
+
* @param {string} orderId The order identifier
|
|
2842
|
+
* @param {ConfirmOrderRequest} confirmOrderRequest ConfirmFulfillment schema
|
|
2843
|
+
* @param {*} [options] Override http request option.
|
|
2844
|
+
* @throws {RequiredError}
|
|
2845
|
+
*/
|
|
2846
|
+
confirmOrder(project: string, platformId: string, orderId: string, confirmOrderRequest: ConfirmOrderRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
|
|
2847
|
+
/**
|
|
2848
|
+
*
|
|
2849
|
+
* @summary Create order
|
|
2850
|
+
* @param {string} project Project unique identifier
|
|
2851
|
+
* @param {string} platformId The platform identifier
|
|
2852
|
+
* @param {CreateOrder} createOrder Create Order schema
|
|
2853
|
+
* @param {*} [options] Override http request option.
|
|
2854
|
+
* @throws {RequiredError}
|
|
2855
|
+
*/
|
|
2856
|
+
createOrder(project: string, platformId: string, createOrder: CreateOrder, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
|
|
2617
2857
|
/**
|
|
2618
2858
|
* Export orders as a CSV file
|
|
2619
2859
|
* @summary Export orders
|
|
@@ -2720,6 +2960,22 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
2720
2960
|
* @export
|
|
2721
2961
|
*/
|
|
2722
2962
|
export declare const OrdersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2963
|
+
/**
|
|
2964
|
+
*
|
|
2965
|
+
* @summary Confirm order
|
|
2966
|
+
* @param {OrdersApiConfirmOrderRequest} requestParameters Request parameters.
|
|
2967
|
+
* @param {*} [options] Override http request option.
|
|
2968
|
+
* @throws {RequiredError}
|
|
2969
|
+
*/
|
|
2970
|
+
confirmOrder(requestParameters: OrdersApiConfirmOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order>;
|
|
2971
|
+
/**
|
|
2972
|
+
*
|
|
2973
|
+
* @summary Create order
|
|
2974
|
+
* @param {OrdersApiCreateOrderRequest} requestParameters Request parameters.
|
|
2975
|
+
* @param {*} [options] Override http request option.
|
|
2976
|
+
* @throws {RequiredError}
|
|
2977
|
+
*/
|
|
2978
|
+
createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order>;
|
|
2723
2979
|
/**
|
|
2724
2980
|
* Export orders as a CSV file
|
|
2725
2981
|
* @summary Export orders
|
|
@@ -2793,6 +3049,62 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
2793
3049
|
*/
|
|
2794
3050
|
updateFulfillment(requestParameters: OrdersApiUpdateFulfillmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Fulfillment>;
|
|
2795
3051
|
};
|
|
3052
|
+
/**
|
|
3053
|
+
* Request parameters for confirmOrder operation in OrdersApi.
|
|
3054
|
+
* @export
|
|
3055
|
+
* @interface OrdersApiConfirmOrderRequest
|
|
3056
|
+
*/
|
|
3057
|
+
export interface OrdersApiConfirmOrderRequest {
|
|
3058
|
+
/**
|
|
3059
|
+
* Project unique identifier
|
|
3060
|
+
* @type {string}
|
|
3061
|
+
* @memberof OrdersApiConfirmOrder
|
|
3062
|
+
*/
|
|
3063
|
+
readonly project: string;
|
|
3064
|
+
/**
|
|
3065
|
+
* The platform identifier
|
|
3066
|
+
* @type {string}
|
|
3067
|
+
* @memberof OrdersApiConfirmOrder
|
|
3068
|
+
*/
|
|
3069
|
+
readonly platformId: string;
|
|
3070
|
+
/**
|
|
3071
|
+
* The order identifier
|
|
3072
|
+
* @type {string}
|
|
3073
|
+
* @memberof OrdersApiConfirmOrder
|
|
3074
|
+
*/
|
|
3075
|
+
readonly orderId: string;
|
|
3076
|
+
/**
|
|
3077
|
+
* ConfirmFulfillment schema
|
|
3078
|
+
* @type {ConfirmOrderRequest}
|
|
3079
|
+
* @memberof OrdersApiConfirmOrder
|
|
3080
|
+
*/
|
|
3081
|
+
readonly confirmOrderRequest: ConfirmOrderRequest;
|
|
3082
|
+
}
|
|
3083
|
+
/**
|
|
3084
|
+
* Request parameters for createOrder operation in OrdersApi.
|
|
3085
|
+
* @export
|
|
3086
|
+
* @interface OrdersApiCreateOrderRequest
|
|
3087
|
+
*/
|
|
3088
|
+
export interface OrdersApiCreateOrderRequest {
|
|
3089
|
+
/**
|
|
3090
|
+
* Project unique identifier
|
|
3091
|
+
* @type {string}
|
|
3092
|
+
* @memberof OrdersApiCreateOrder
|
|
3093
|
+
*/
|
|
3094
|
+
readonly project: string;
|
|
3095
|
+
/**
|
|
3096
|
+
* The platform identifier
|
|
3097
|
+
* @type {string}
|
|
3098
|
+
* @memberof OrdersApiCreateOrder
|
|
3099
|
+
*/
|
|
3100
|
+
readonly platformId: string;
|
|
3101
|
+
/**
|
|
3102
|
+
* Create Order schema
|
|
3103
|
+
* @type {CreateOrder}
|
|
3104
|
+
* @memberof OrdersApiCreateOrder
|
|
3105
|
+
*/
|
|
3106
|
+
readonly createOrder: CreateOrder;
|
|
3107
|
+
}
|
|
2796
3108
|
/**
|
|
2797
3109
|
* Request parameters for exportOrders operation in OrdersApi.
|
|
2798
3110
|
* @export
|
|
@@ -3085,6 +3397,24 @@ export interface OrdersApiUpdateFulfillmentRequest {
|
|
|
3085
3397
|
* @extends {BaseAPI}
|
|
3086
3398
|
*/
|
|
3087
3399
|
export declare class OrdersApi extends BaseAPI {
|
|
3400
|
+
/**
|
|
3401
|
+
*
|
|
3402
|
+
* @summary Confirm order
|
|
3403
|
+
* @param {OrdersApiConfirmOrderRequest} requestParameters Request parameters.
|
|
3404
|
+
* @param {*} [options] Override http request option.
|
|
3405
|
+
* @throws {RequiredError}
|
|
3406
|
+
* @memberof OrdersApi
|
|
3407
|
+
*/
|
|
3408
|
+
confirmOrder(requestParameters: OrdersApiConfirmOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
|
|
3409
|
+
/**
|
|
3410
|
+
*
|
|
3411
|
+
* @summary Create order
|
|
3412
|
+
* @param {OrdersApiCreateOrderRequest} requestParameters Request parameters.
|
|
3413
|
+
* @param {*} [options] Override http request option.
|
|
3414
|
+
* @throws {RequiredError}
|
|
3415
|
+
* @memberof OrdersApi
|
|
3416
|
+
*/
|
|
3417
|
+
createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
|
|
3088
3418
|
/**
|
|
3089
3419
|
* Export orders as a CSV file
|
|
3090
3420
|
* @summary Export orders
|
package/dist/esm/api.js
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).
|
|
@@ -26,6 +26,9 @@ import globalAxios from 'axios';
|
|
|
26
26
|
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
|
|
27
27
|
// @ts-ignore
|
|
28
28
|
import { BASE_PATH, BaseAPI, operationServerMap } from './base';
|
|
29
|
+
export const CustomsInformationPreRegistrationTypeEnum = {
|
|
30
|
+
Ioss: 'IOSS'
|
|
31
|
+
};
|
|
29
32
|
export const EnquiryStatusEnum = {
|
|
30
33
|
New: 'New',
|
|
31
34
|
Archived: 'Archived',
|
|
@@ -954,6 +957,100 @@ export class EnquiriesApi extends BaseAPI {
|
|
|
954
957
|
*/
|
|
955
958
|
export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
956
959
|
return {
|
|
960
|
+
/**
|
|
961
|
+
*
|
|
962
|
+
* @summary Confirm order
|
|
963
|
+
* @param {string} project Project unique identifier
|
|
964
|
+
* @param {string} platformId The platform identifier
|
|
965
|
+
* @param {string} orderId The order identifier
|
|
966
|
+
* @param {ConfirmOrderRequest} confirmOrderRequest ConfirmFulfillment schema
|
|
967
|
+
* @param {*} [options] Override http request option.
|
|
968
|
+
* @throws {RequiredError}
|
|
969
|
+
*/
|
|
970
|
+
confirmOrder: (project_1, platformId_1, orderId_1, confirmOrderRequest_1, ...args_1) => __awaiter(this, [project_1, platformId_1, orderId_1, confirmOrderRequest_1, ...args_1], void 0, function* (project, platformId, orderId, confirmOrderRequest, options = {}) {
|
|
971
|
+
// verify required parameter 'project' is not null or undefined
|
|
972
|
+
assertParamExists('confirmOrder', 'project', project);
|
|
973
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
974
|
+
assertParamExists('confirmOrder', 'platformId', platformId);
|
|
975
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
976
|
+
assertParamExists('confirmOrder', 'orderId', orderId);
|
|
977
|
+
// verify required parameter 'confirmOrderRequest' is not null or undefined
|
|
978
|
+
assertParamExists('confirmOrder', 'confirmOrderRequest', confirmOrderRequest);
|
|
979
|
+
const localVarPath = `/v1/platform/{platformId}/orders/{orderId}/confirm`
|
|
980
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
981
|
+
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
|
|
982
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
983
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
984
|
+
let baseOptions;
|
|
985
|
+
if (configuration) {
|
|
986
|
+
baseOptions = configuration.baseOptions;
|
|
987
|
+
}
|
|
988
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
989
|
+
const localVarHeaderParameter = {};
|
|
990
|
+
const localVarQueryParameter = {};
|
|
991
|
+
// authentication session-oauth required
|
|
992
|
+
// oauth required
|
|
993
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
994
|
+
// authentication api-key required
|
|
995
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
996
|
+
if (project !== undefined) {
|
|
997
|
+
localVarQueryParameter['project'] = project;
|
|
998
|
+
}
|
|
999
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1000
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1001
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1002
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1003
|
+
localVarRequestOptions.data = serializeDataIfNeeded(confirmOrderRequest, localVarRequestOptions, configuration);
|
|
1004
|
+
return {
|
|
1005
|
+
url: toPathString(localVarUrlObj),
|
|
1006
|
+
options: localVarRequestOptions,
|
|
1007
|
+
};
|
|
1008
|
+
}),
|
|
1009
|
+
/**
|
|
1010
|
+
*
|
|
1011
|
+
* @summary Create order
|
|
1012
|
+
* @param {string} project Project unique identifier
|
|
1013
|
+
* @param {string} platformId The platform identifier
|
|
1014
|
+
* @param {CreateOrder} createOrder Create Order schema
|
|
1015
|
+
* @param {*} [options] Override http request option.
|
|
1016
|
+
* @throws {RequiredError}
|
|
1017
|
+
*/
|
|
1018
|
+
createOrder: (project_1, platformId_1, createOrder_1, ...args_1) => __awaiter(this, [project_1, platformId_1, createOrder_1, ...args_1], void 0, function* (project, platformId, createOrder, options = {}) {
|
|
1019
|
+
// verify required parameter 'project' is not null or undefined
|
|
1020
|
+
assertParamExists('createOrder', 'project', project);
|
|
1021
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
1022
|
+
assertParamExists('createOrder', 'platformId', platformId);
|
|
1023
|
+
// verify required parameter 'createOrder' is not null or undefined
|
|
1024
|
+
assertParamExists('createOrder', 'createOrder', createOrder);
|
|
1025
|
+
const localVarPath = `/v1/platform/{platformId}/orders`
|
|
1026
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
1027
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1028
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1029
|
+
let baseOptions;
|
|
1030
|
+
if (configuration) {
|
|
1031
|
+
baseOptions = configuration.baseOptions;
|
|
1032
|
+
}
|
|
1033
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
1034
|
+
const localVarHeaderParameter = {};
|
|
1035
|
+
const localVarQueryParameter = {};
|
|
1036
|
+
// authentication session-oauth required
|
|
1037
|
+
// oauth required
|
|
1038
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
1039
|
+
// authentication api-key required
|
|
1040
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
1041
|
+
if (project !== undefined) {
|
|
1042
|
+
localVarQueryParameter['project'] = project;
|
|
1043
|
+
}
|
|
1044
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1045
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1046
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1047
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1048
|
+
localVarRequestOptions.data = serializeDataIfNeeded(createOrder, localVarRequestOptions, configuration);
|
|
1049
|
+
return {
|
|
1050
|
+
url: toPathString(localVarUrlObj),
|
|
1051
|
+
options: localVarRequestOptions,
|
|
1052
|
+
};
|
|
1053
|
+
}),
|
|
957
1054
|
/**
|
|
958
1055
|
* Export orders as a CSV file
|
|
959
1056
|
* @summary Export orders
|
|
@@ -1410,6 +1507,43 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
1410
1507
|
export const OrdersApiFp = function (configuration) {
|
|
1411
1508
|
const localVarAxiosParamCreator = OrdersApiAxiosParamCreator(configuration);
|
|
1412
1509
|
return {
|
|
1510
|
+
/**
|
|
1511
|
+
*
|
|
1512
|
+
* @summary Confirm order
|
|
1513
|
+
* @param {string} project Project unique identifier
|
|
1514
|
+
* @param {string} platformId The platform identifier
|
|
1515
|
+
* @param {string} orderId The order identifier
|
|
1516
|
+
* @param {ConfirmOrderRequest} confirmOrderRequest ConfirmFulfillment schema
|
|
1517
|
+
* @param {*} [options] Override http request option.
|
|
1518
|
+
* @throws {RequiredError}
|
|
1519
|
+
*/
|
|
1520
|
+
confirmOrder(project, platformId, orderId, confirmOrderRequest, options) {
|
|
1521
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1522
|
+
var _a, _b, _c;
|
|
1523
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.confirmOrder(project, platformId, orderId, confirmOrderRequest, options);
|
|
1524
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1525
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrdersApi.confirmOrder']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1526
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1527
|
+
});
|
|
1528
|
+
},
|
|
1529
|
+
/**
|
|
1530
|
+
*
|
|
1531
|
+
* @summary Create order
|
|
1532
|
+
* @param {string} project Project unique identifier
|
|
1533
|
+
* @param {string} platformId The platform identifier
|
|
1534
|
+
* @param {CreateOrder} createOrder Create Order schema
|
|
1535
|
+
* @param {*} [options] Override http request option.
|
|
1536
|
+
* @throws {RequiredError}
|
|
1537
|
+
*/
|
|
1538
|
+
createOrder(project, platformId, createOrder, options) {
|
|
1539
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1540
|
+
var _a, _b, _c;
|
|
1541
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.createOrder(project, platformId, createOrder, options);
|
|
1542
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1543
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrdersApi.createOrder']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1544
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1545
|
+
});
|
|
1546
|
+
},
|
|
1413
1547
|
/**
|
|
1414
1548
|
* Export orders as a CSV file
|
|
1415
1549
|
* @summary Export orders
|
|
@@ -1591,6 +1725,26 @@ export const OrdersApiFp = function (configuration) {
|
|
|
1591
1725
|
export const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
1592
1726
|
const localVarFp = OrdersApiFp(configuration);
|
|
1593
1727
|
return {
|
|
1728
|
+
/**
|
|
1729
|
+
*
|
|
1730
|
+
* @summary Confirm order
|
|
1731
|
+
* @param {OrdersApiConfirmOrderRequest} requestParameters Request parameters.
|
|
1732
|
+
* @param {*} [options] Override http request option.
|
|
1733
|
+
* @throws {RequiredError}
|
|
1734
|
+
*/
|
|
1735
|
+
confirmOrder(requestParameters, options) {
|
|
1736
|
+
return localVarFp.confirmOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, requestParameters.confirmOrderRequest, options).then((request) => request(axios, basePath));
|
|
1737
|
+
},
|
|
1738
|
+
/**
|
|
1739
|
+
*
|
|
1740
|
+
* @summary Create order
|
|
1741
|
+
* @param {OrdersApiCreateOrderRequest} requestParameters Request parameters.
|
|
1742
|
+
* @param {*} [options] Override http request option.
|
|
1743
|
+
* @throws {RequiredError}
|
|
1744
|
+
*/
|
|
1745
|
+
createOrder(requestParameters, options) {
|
|
1746
|
+
return localVarFp.createOrder(requestParameters.project, requestParameters.platformId, requestParameters.createOrder, options).then((request) => request(axios, basePath));
|
|
1747
|
+
},
|
|
1594
1748
|
/**
|
|
1595
1749
|
* Export orders as a CSV file
|
|
1596
1750
|
* @summary Export orders
|
|
@@ -1690,6 +1844,28 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
1690
1844
|
* @extends {BaseAPI}
|
|
1691
1845
|
*/
|
|
1692
1846
|
export class OrdersApi extends BaseAPI {
|
|
1847
|
+
/**
|
|
1848
|
+
*
|
|
1849
|
+
* @summary Confirm order
|
|
1850
|
+
* @param {OrdersApiConfirmOrderRequest} requestParameters Request parameters.
|
|
1851
|
+
* @param {*} [options] Override http request option.
|
|
1852
|
+
* @throws {RequiredError}
|
|
1853
|
+
* @memberof OrdersApi
|
|
1854
|
+
*/
|
|
1855
|
+
confirmOrder(requestParameters, options) {
|
|
1856
|
+
return OrdersApiFp(this.configuration).confirmOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, requestParameters.confirmOrderRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1857
|
+
}
|
|
1858
|
+
/**
|
|
1859
|
+
*
|
|
1860
|
+
* @summary Create order
|
|
1861
|
+
* @param {OrdersApiCreateOrderRequest} requestParameters Request parameters.
|
|
1862
|
+
* @param {*} [options] Override http request option.
|
|
1863
|
+
* @throws {RequiredError}
|
|
1864
|
+
* @memberof OrdersApi
|
|
1865
|
+
*/
|
|
1866
|
+
createOrder(requestParameters, options) {
|
|
1867
|
+
return OrdersApiFp(this.configuration).createOrder(requestParameters.project, requestParameters.platformId, requestParameters.createOrder, options).then((request) => request(this.axios, this.basePath));
|
|
1868
|
+
}
|
|
1693
1869
|
/**
|
|
1694
1870
|
* Export orders as a CSV file
|
|
1695
1871
|
* @summary Export orders
|
package/dist/esm/base.d.ts
CHANGED
package/dist/esm/base.js
CHANGED
package/dist/esm/common.d.ts
CHANGED
package/dist/esm/common.js
CHANGED
package/dist/esm/index.d.ts
CHANGED