@teemill/platform 0.29.2 → 0.30.1
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 +7 -2
- package/api.ts +328 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +203 -1
- package/dist/api.js +184 -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 +203 -1
- package/dist/esm/api.js +183 -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/AmendOrderRequest.md +20 -0
- package/docs/AmendOrderRequestAmendmentsInner.md +26 -0
- package/docs/OrdersApi.md +132 -0
- package/docs/ReturnOrderRequest.md +20 -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.30.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -68,6 +68,55 @@ export interface Address {
|
|
|
68
68
|
*/
|
|
69
69
|
'state'?: string;
|
|
70
70
|
}
|
|
71
|
+
/**
|
|
72
|
+
*
|
|
73
|
+
* @export
|
|
74
|
+
* @interface AmendOrderRequest
|
|
75
|
+
*/
|
|
76
|
+
export interface AmendOrderRequest {
|
|
77
|
+
/**
|
|
78
|
+
*
|
|
79
|
+
* @type {Array<AmendOrderRequestAmendmentsInner>}
|
|
80
|
+
* @memberof AmendOrderRequest
|
|
81
|
+
*/
|
|
82
|
+
'amendments': Array<AmendOrderRequestAmendmentsInner>;
|
|
83
|
+
}
|
|
84
|
+
/**
|
|
85
|
+
*
|
|
86
|
+
* @export
|
|
87
|
+
* @interface AmendOrderRequestAmendmentsInner
|
|
88
|
+
*/
|
|
89
|
+
export interface AmendOrderRequestAmendmentsInner {
|
|
90
|
+
/**
|
|
91
|
+
* Unique order item identifier
|
|
92
|
+
* @type {string}
|
|
93
|
+
* @memberof AmendOrderRequestAmendmentsInner
|
|
94
|
+
*/
|
|
95
|
+
'id': string;
|
|
96
|
+
/**
|
|
97
|
+
*
|
|
98
|
+
* @type {string}
|
|
99
|
+
* @memberof AmendOrderRequestAmendmentsInner
|
|
100
|
+
*/
|
|
101
|
+
'action': AmendOrderRequestAmendmentsInnerActionEnum;
|
|
102
|
+
/**
|
|
103
|
+
* The quantity of the item to refund or exchange. This must be less than or equal to the quantity of the item in the order.
|
|
104
|
+
* @type {number}
|
|
105
|
+
* @memberof AmendOrderRequestAmendmentsInner
|
|
106
|
+
*/
|
|
107
|
+
'quantity': number;
|
|
108
|
+
/**
|
|
109
|
+
* A reference to the variant being ordered
|
|
110
|
+
* @type {string}
|
|
111
|
+
* @memberof AmendOrderRequestAmendmentsInner
|
|
112
|
+
*/
|
|
113
|
+
'newVariantRef'?: string;
|
|
114
|
+
}
|
|
115
|
+
export declare const AmendOrderRequestAmendmentsInnerActionEnum: {
|
|
116
|
+
readonly Refund: "refund";
|
|
117
|
+
readonly Exchange: "exchange";
|
|
118
|
+
};
|
|
119
|
+
export type AmendOrderRequestAmendmentsInnerActionEnum = typeof AmendOrderRequestAmendmentsInnerActionEnum[keyof typeof AmendOrderRequestAmendmentsInnerActionEnum];
|
|
71
120
|
/**
|
|
72
121
|
*
|
|
73
122
|
* @export
|
|
@@ -1448,6 +1497,19 @@ export interface Project {
|
|
|
1448
1497
|
*/
|
|
1449
1498
|
'name': string;
|
|
1450
1499
|
}
|
|
1500
|
+
/**
|
|
1501
|
+
*
|
|
1502
|
+
* @export
|
|
1503
|
+
* @interface ReturnOrderRequest
|
|
1504
|
+
*/
|
|
1505
|
+
export interface ReturnOrderRequest {
|
|
1506
|
+
/**
|
|
1507
|
+
*
|
|
1508
|
+
* @type {Array<AmendOrderRequestAmendmentsInner>}
|
|
1509
|
+
* @memberof ReturnOrderRequest
|
|
1510
|
+
*/
|
|
1511
|
+
'returns': Array<AmendOrderRequestAmendmentsInner>;
|
|
1512
|
+
}
|
|
1451
1513
|
/**
|
|
1452
1514
|
*
|
|
1453
1515
|
* @export
|
|
@@ -2812,6 +2874,17 @@ export declare class EnquiriesApi extends BaseAPI {
|
|
|
2812
2874
|
* @export
|
|
2813
2875
|
*/
|
|
2814
2876
|
export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2877
|
+
/**
|
|
2878
|
+
*
|
|
2879
|
+
* @summary Amend the contents of an order
|
|
2880
|
+
* @param {string} project Project unique identifier
|
|
2881
|
+
* @param {string} platformId The platform identifier
|
|
2882
|
+
* @param {string} orderId The order identifier
|
|
2883
|
+
* @param {AmendOrderRequest} amendOrderRequest AmendOrder schema
|
|
2884
|
+
* @param {*} [options] Override http request option.
|
|
2885
|
+
* @throws {RequiredError}
|
|
2886
|
+
*/
|
|
2887
|
+
amendOrder: (project: string, platformId: string, orderId: string, amendOrderRequest: AmendOrderRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2815
2888
|
/**
|
|
2816
2889
|
*
|
|
2817
2890
|
* @summary Confirm order
|
|
@@ -2912,6 +2985,17 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
2912
2985
|
* @throws {RequiredError}
|
|
2913
2986
|
*/
|
|
2914
2987
|
retryPlatformPayment: (project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2988
|
+
/**
|
|
2989
|
+
*
|
|
2990
|
+
* @summary Return the contents of an order for a refund or exchange
|
|
2991
|
+
* @param {string} project Project unique identifier
|
|
2992
|
+
* @param {string} platformId The platform identifier
|
|
2993
|
+
* @param {string} orderId The order identifier
|
|
2994
|
+
* @param {ReturnOrderRequest} returnOrderRequest ReturnOrder schema
|
|
2995
|
+
* @param {*} [options] Override http request option.
|
|
2996
|
+
* @throws {RequiredError}
|
|
2997
|
+
*/
|
|
2998
|
+
returnOrder: (project: string, platformId: string, orderId: string, returnOrderRequest: ReturnOrderRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2915
2999
|
/**
|
|
2916
3000
|
* Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
|
|
2917
3001
|
* @summary Send order receipt
|
|
@@ -2939,6 +3023,17 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
2939
3023
|
* @export
|
|
2940
3024
|
*/
|
|
2941
3025
|
export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
3026
|
+
/**
|
|
3027
|
+
*
|
|
3028
|
+
* @summary Amend the contents of an order
|
|
3029
|
+
* @param {string} project Project unique identifier
|
|
3030
|
+
* @param {string} platformId The platform identifier
|
|
3031
|
+
* @param {string} orderId The order identifier
|
|
3032
|
+
* @param {AmendOrderRequest} amendOrderRequest AmendOrder schema
|
|
3033
|
+
* @param {*} [options] Override http request option.
|
|
3034
|
+
* @throws {RequiredError}
|
|
3035
|
+
*/
|
|
3036
|
+
amendOrder(project: string, platformId: string, orderId: string, amendOrderRequest: AmendOrderRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
|
|
2942
3037
|
/**
|
|
2943
3038
|
*
|
|
2944
3039
|
* @summary Confirm order
|
|
@@ -3039,6 +3134,17 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
3039
3134
|
* @throws {RequiredError}
|
|
3040
3135
|
*/
|
|
3041
3136
|
retryPlatformPayment(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
|
|
3137
|
+
/**
|
|
3138
|
+
*
|
|
3139
|
+
* @summary Return the contents of an order for a refund or exchange
|
|
3140
|
+
* @param {string} project Project unique identifier
|
|
3141
|
+
* @param {string} platformId The platform identifier
|
|
3142
|
+
* @param {string} orderId The order identifier
|
|
3143
|
+
* @param {ReturnOrderRequest} returnOrderRequest ReturnOrder schema
|
|
3144
|
+
* @param {*} [options] Override http request option.
|
|
3145
|
+
* @throws {RequiredError}
|
|
3146
|
+
*/
|
|
3147
|
+
returnOrder(project: string, platformId: string, orderId: string, returnOrderRequest: ReturnOrderRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
|
|
3042
3148
|
/**
|
|
3043
3149
|
* Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
|
|
3044
3150
|
* @summary Send order receipt
|
|
@@ -3066,6 +3172,14 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
3066
3172
|
* @export
|
|
3067
3173
|
*/
|
|
3068
3174
|
export declare const OrdersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3175
|
+
/**
|
|
3176
|
+
*
|
|
3177
|
+
* @summary Amend the contents of an order
|
|
3178
|
+
* @param {OrdersApiAmendOrderRequest} requestParameters Request parameters.
|
|
3179
|
+
* @param {*} [options] Override http request option.
|
|
3180
|
+
* @throws {RequiredError}
|
|
3181
|
+
*/
|
|
3182
|
+
amendOrder(requestParameters: OrdersApiAmendOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order>;
|
|
3069
3183
|
/**
|
|
3070
3184
|
*
|
|
3071
3185
|
* @summary Confirm order
|
|
@@ -3138,6 +3252,14 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
3138
3252
|
* @throws {RequiredError}
|
|
3139
3253
|
*/
|
|
3140
3254
|
retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order>;
|
|
3255
|
+
/**
|
|
3256
|
+
*
|
|
3257
|
+
* @summary Return the contents of an order for a refund or exchange
|
|
3258
|
+
* @param {OrdersApiReturnOrderRequest} requestParameters Request parameters.
|
|
3259
|
+
* @param {*} [options] Override http request option.
|
|
3260
|
+
* @throws {RequiredError}
|
|
3261
|
+
*/
|
|
3262
|
+
returnOrder(requestParameters: OrdersApiReturnOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order>;
|
|
3141
3263
|
/**
|
|
3142
3264
|
* Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
|
|
3143
3265
|
* @summary Send order receipt
|
|
@@ -3155,6 +3277,37 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
3155
3277
|
*/
|
|
3156
3278
|
updateFulfillment(requestParameters: OrdersApiUpdateFulfillmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Fulfillment>;
|
|
3157
3279
|
};
|
|
3280
|
+
/**
|
|
3281
|
+
* Request parameters for amendOrder operation in OrdersApi.
|
|
3282
|
+
* @export
|
|
3283
|
+
* @interface OrdersApiAmendOrderRequest
|
|
3284
|
+
*/
|
|
3285
|
+
export interface OrdersApiAmendOrderRequest {
|
|
3286
|
+
/**
|
|
3287
|
+
* Project unique identifier
|
|
3288
|
+
* @type {string}
|
|
3289
|
+
* @memberof OrdersApiAmendOrder
|
|
3290
|
+
*/
|
|
3291
|
+
readonly project: string;
|
|
3292
|
+
/**
|
|
3293
|
+
* The platform identifier
|
|
3294
|
+
* @type {string}
|
|
3295
|
+
* @memberof OrdersApiAmendOrder
|
|
3296
|
+
*/
|
|
3297
|
+
readonly platformId: string;
|
|
3298
|
+
/**
|
|
3299
|
+
* The order identifier
|
|
3300
|
+
* @type {string}
|
|
3301
|
+
* @memberof OrdersApiAmendOrder
|
|
3302
|
+
*/
|
|
3303
|
+
readonly orderId: string;
|
|
3304
|
+
/**
|
|
3305
|
+
* AmendOrder schema
|
|
3306
|
+
* @type {AmendOrderRequest}
|
|
3307
|
+
* @memberof OrdersApiAmendOrder
|
|
3308
|
+
*/
|
|
3309
|
+
readonly amendOrderRequest: AmendOrderRequest;
|
|
3310
|
+
}
|
|
3158
3311
|
/**
|
|
3159
3312
|
* Request parameters for confirmOrder operation in OrdersApi.
|
|
3160
3313
|
* @export
|
|
@@ -3440,6 +3593,37 @@ export interface OrdersApiRetryPlatformPaymentRequest {
|
|
|
3440
3593
|
*/
|
|
3441
3594
|
readonly orderId: string;
|
|
3442
3595
|
}
|
|
3596
|
+
/**
|
|
3597
|
+
* Request parameters for returnOrder operation in OrdersApi.
|
|
3598
|
+
* @export
|
|
3599
|
+
* @interface OrdersApiReturnOrderRequest
|
|
3600
|
+
*/
|
|
3601
|
+
export interface OrdersApiReturnOrderRequest {
|
|
3602
|
+
/**
|
|
3603
|
+
* Project unique identifier
|
|
3604
|
+
* @type {string}
|
|
3605
|
+
* @memberof OrdersApiReturnOrder
|
|
3606
|
+
*/
|
|
3607
|
+
readonly project: string;
|
|
3608
|
+
/**
|
|
3609
|
+
* The platform identifier
|
|
3610
|
+
* @type {string}
|
|
3611
|
+
* @memberof OrdersApiReturnOrder
|
|
3612
|
+
*/
|
|
3613
|
+
readonly platformId: string;
|
|
3614
|
+
/**
|
|
3615
|
+
* The order identifier
|
|
3616
|
+
* @type {string}
|
|
3617
|
+
* @memberof OrdersApiReturnOrder
|
|
3618
|
+
*/
|
|
3619
|
+
readonly orderId: string;
|
|
3620
|
+
/**
|
|
3621
|
+
* ReturnOrder schema
|
|
3622
|
+
* @type {ReturnOrderRequest}
|
|
3623
|
+
* @memberof OrdersApiReturnOrder
|
|
3624
|
+
*/
|
|
3625
|
+
readonly returnOrderRequest: ReturnOrderRequest;
|
|
3626
|
+
}
|
|
3443
3627
|
/**
|
|
3444
3628
|
* Request parameters for sendOrderReceipt operation in OrdersApi.
|
|
3445
3629
|
* @export
|
|
@@ -3503,6 +3687,15 @@ export interface OrdersApiUpdateFulfillmentRequest {
|
|
|
3503
3687
|
* @extends {BaseAPI}
|
|
3504
3688
|
*/
|
|
3505
3689
|
export declare class OrdersApi extends BaseAPI {
|
|
3690
|
+
/**
|
|
3691
|
+
*
|
|
3692
|
+
* @summary Amend the contents of an order
|
|
3693
|
+
* @param {OrdersApiAmendOrderRequest} requestParameters Request parameters.
|
|
3694
|
+
* @param {*} [options] Override http request option.
|
|
3695
|
+
* @throws {RequiredError}
|
|
3696
|
+
* @memberof OrdersApi
|
|
3697
|
+
*/
|
|
3698
|
+
amendOrder(requestParameters: OrdersApiAmendOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
|
|
3506
3699
|
/**
|
|
3507
3700
|
*
|
|
3508
3701
|
* @summary Confirm order
|
|
@@ -3584,6 +3777,15 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
3584
3777
|
* @memberof OrdersApi
|
|
3585
3778
|
*/
|
|
3586
3779
|
retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
|
|
3780
|
+
/**
|
|
3781
|
+
*
|
|
3782
|
+
* @summary Return the contents of an order for a refund or exchange
|
|
3783
|
+
* @param {OrdersApiReturnOrderRequest} requestParameters Request parameters.
|
|
3784
|
+
* @param {*} [options] Override http request option.
|
|
3785
|
+
* @throws {RequiredError}
|
|
3786
|
+
* @memberof OrdersApi
|
|
3787
|
+
*/
|
|
3788
|
+
returnOrder(requestParameters: OrdersApiReturnOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
|
|
3587
3789
|
/**
|
|
3588
3790
|
* Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
|
|
3589
3791
|
* @summary Send order receipt
|
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.30.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -26,6 +26,10 @@ 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 AmendOrderRequestAmendmentsInnerActionEnum = {
|
|
30
|
+
Refund: 'refund',
|
|
31
|
+
Exchange: 'exchange'
|
|
32
|
+
};
|
|
29
33
|
export const CustomsInformationPreRegistrationTypeEnum = {
|
|
30
34
|
Ioss: 'IOSS'
|
|
31
35
|
};
|
|
@@ -1021,6 +1025,55 @@ export class EnquiriesApi extends BaseAPI {
|
|
|
1021
1025
|
*/
|
|
1022
1026
|
export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
1023
1027
|
return {
|
|
1028
|
+
/**
|
|
1029
|
+
*
|
|
1030
|
+
* @summary Amend the contents of an order
|
|
1031
|
+
* @param {string} project Project unique identifier
|
|
1032
|
+
* @param {string} platformId The platform identifier
|
|
1033
|
+
* @param {string} orderId The order identifier
|
|
1034
|
+
* @param {AmendOrderRequest} amendOrderRequest AmendOrder schema
|
|
1035
|
+
* @param {*} [options] Override http request option.
|
|
1036
|
+
* @throws {RequiredError}
|
|
1037
|
+
*/
|
|
1038
|
+
amendOrder: (project_1, platformId_1, orderId_1, amendOrderRequest_1, ...args_1) => __awaiter(this, [project_1, platformId_1, orderId_1, amendOrderRequest_1, ...args_1], void 0, function* (project, platformId, orderId, amendOrderRequest, options = {}) {
|
|
1039
|
+
// verify required parameter 'project' is not null or undefined
|
|
1040
|
+
assertParamExists('amendOrder', 'project', project);
|
|
1041
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
1042
|
+
assertParamExists('amendOrder', 'platformId', platformId);
|
|
1043
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
1044
|
+
assertParamExists('amendOrder', 'orderId', orderId);
|
|
1045
|
+
// verify required parameter 'amendOrderRequest' is not null or undefined
|
|
1046
|
+
assertParamExists('amendOrder', 'amendOrderRequest', amendOrderRequest);
|
|
1047
|
+
const localVarPath = `/v1/platform/{platformId}/orders/{orderId}/amend`
|
|
1048
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
1049
|
+
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
|
|
1050
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1051
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1052
|
+
let baseOptions;
|
|
1053
|
+
if (configuration) {
|
|
1054
|
+
baseOptions = configuration.baseOptions;
|
|
1055
|
+
}
|
|
1056
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
|
|
1057
|
+
const localVarHeaderParameter = {};
|
|
1058
|
+
const localVarQueryParameter = {};
|
|
1059
|
+
// authentication session-oauth required
|
|
1060
|
+
// oauth required
|
|
1061
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
1062
|
+
// authentication api-key required
|
|
1063
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
1064
|
+
if (project !== undefined) {
|
|
1065
|
+
localVarQueryParameter['project'] = project;
|
|
1066
|
+
}
|
|
1067
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1068
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1069
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1070
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1071
|
+
localVarRequestOptions.data = serializeDataIfNeeded(amendOrderRequest, localVarRequestOptions, configuration);
|
|
1072
|
+
return {
|
|
1073
|
+
url: toPathString(localVarUrlObj),
|
|
1074
|
+
options: localVarRequestOptions,
|
|
1075
|
+
};
|
|
1076
|
+
}),
|
|
1024
1077
|
/**
|
|
1025
1078
|
*
|
|
1026
1079
|
* @summary Confirm order
|
|
@@ -1469,6 +1522,55 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
1469
1522
|
options: localVarRequestOptions,
|
|
1470
1523
|
};
|
|
1471
1524
|
}),
|
|
1525
|
+
/**
|
|
1526
|
+
*
|
|
1527
|
+
* @summary Return the contents of an order for a refund or exchange
|
|
1528
|
+
* @param {string} project Project unique identifier
|
|
1529
|
+
* @param {string} platformId The platform identifier
|
|
1530
|
+
* @param {string} orderId The order identifier
|
|
1531
|
+
* @param {ReturnOrderRequest} returnOrderRequest ReturnOrder schema
|
|
1532
|
+
* @param {*} [options] Override http request option.
|
|
1533
|
+
* @throws {RequiredError}
|
|
1534
|
+
*/
|
|
1535
|
+
returnOrder: (project_1, platformId_1, orderId_1, returnOrderRequest_1, ...args_1) => __awaiter(this, [project_1, platformId_1, orderId_1, returnOrderRequest_1, ...args_1], void 0, function* (project, platformId, orderId, returnOrderRequest, options = {}) {
|
|
1536
|
+
// verify required parameter 'project' is not null or undefined
|
|
1537
|
+
assertParamExists('returnOrder', 'project', project);
|
|
1538
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
1539
|
+
assertParamExists('returnOrder', 'platformId', platformId);
|
|
1540
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
1541
|
+
assertParamExists('returnOrder', 'orderId', orderId);
|
|
1542
|
+
// verify required parameter 'returnOrderRequest' is not null or undefined
|
|
1543
|
+
assertParamExists('returnOrder', 'returnOrderRequest', returnOrderRequest);
|
|
1544
|
+
const localVarPath = `/v1/platform/{platformId}/orders/{orderId}/return`
|
|
1545
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
1546
|
+
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
|
|
1547
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1548
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1549
|
+
let baseOptions;
|
|
1550
|
+
if (configuration) {
|
|
1551
|
+
baseOptions = configuration.baseOptions;
|
|
1552
|
+
}
|
|
1553
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
|
|
1554
|
+
const localVarHeaderParameter = {};
|
|
1555
|
+
const localVarQueryParameter = {};
|
|
1556
|
+
// authentication session-oauth required
|
|
1557
|
+
// oauth required
|
|
1558
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
1559
|
+
// authentication api-key required
|
|
1560
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
1561
|
+
if (project !== undefined) {
|
|
1562
|
+
localVarQueryParameter['project'] = project;
|
|
1563
|
+
}
|
|
1564
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1565
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1566
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1567
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1568
|
+
localVarRequestOptions.data = serializeDataIfNeeded(returnOrderRequest, localVarRequestOptions, configuration);
|
|
1569
|
+
return {
|
|
1570
|
+
url: toPathString(localVarUrlObj),
|
|
1571
|
+
options: localVarRequestOptions,
|
|
1572
|
+
};
|
|
1573
|
+
}),
|
|
1472
1574
|
/**
|
|
1473
1575
|
* Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
|
|
1474
1576
|
* @summary Send order receipt
|
|
@@ -1571,6 +1673,25 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
1571
1673
|
export const OrdersApiFp = function (configuration) {
|
|
1572
1674
|
const localVarAxiosParamCreator = OrdersApiAxiosParamCreator(configuration);
|
|
1573
1675
|
return {
|
|
1676
|
+
/**
|
|
1677
|
+
*
|
|
1678
|
+
* @summary Amend the contents of an order
|
|
1679
|
+
* @param {string} project Project unique identifier
|
|
1680
|
+
* @param {string} platformId The platform identifier
|
|
1681
|
+
* @param {string} orderId The order identifier
|
|
1682
|
+
* @param {AmendOrderRequest} amendOrderRequest AmendOrder schema
|
|
1683
|
+
* @param {*} [options] Override http request option.
|
|
1684
|
+
* @throws {RequiredError}
|
|
1685
|
+
*/
|
|
1686
|
+
amendOrder(project, platformId, orderId, amendOrderRequest, options) {
|
|
1687
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1688
|
+
var _a, _b, _c;
|
|
1689
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.amendOrder(project, platformId, orderId, amendOrderRequest, options);
|
|
1690
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1691
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrdersApi.amendOrder']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1692
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1693
|
+
});
|
|
1694
|
+
},
|
|
1574
1695
|
/**
|
|
1575
1696
|
*
|
|
1576
1697
|
* @summary Confirm order
|
|
@@ -1743,6 +1864,25 @@ export const OrdersApiFp = function (configuration) {
|
|
|
1743
1864
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1744
1865
|
});
|
|
1745
1866
|
},
|
|
1867
|
+
/**
|
|
1868
|
+
*
|
|
1869
|
+
* @summary Return the contents of an order for a refund or exchange
|
|
1870
|
+
* @param {string} project Project unique identifier
|
|
1871
|
+
* @param {string} platformId The platform identifier
|
|
1872
|
+
* @param {string} orderId The order identifier
|
|
1873
|
+
* @param {ReturnOrderRequest} returnOrderRequest ReturnOrder schema
|
|
1874
|
+
* @param {*} [options] Override http request option.
|
|
1875
|
+
* @throws {RequiredError}
|
|
1876
|
+
*/
|
|
1877
|
+
returnOrder(project, platformId, orderId, returnOrderRequest, options) {
|
|
1878
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1879
|
+
var _a, _b, _c;
|
|
1880
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.returnOrder(project, platformId, orderId, returnOrderRequest, options);
|
|
1881
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1882
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrdersApi.returnOrder']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1883
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1884
|
+
});
|
|
1885
|
+
},
|
|
1746
1886
|
/**
|
|
1747
1887
|
* Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
|
|
1748
1888
|
* @summary Send order receipt
|
|
@@ -1789,6 +1929,16 @@ export const OrdersApiFp = function (configuration) {
|
|
|
1789
1929
|
export const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
1790
1930
|
const localVarFp = OrdersApiFp(configuration);
|
|
1791
1931
|
return {
|
|
1932
|
+
/**
|
|
1933
|
+
*
|
|
1934
|
+
* @summary Amend the contents of an order
|
|
1935
|
+
* @param {OrdersApiAmendOrderRequest} requestParameters Request parameters.
|
|
1936
|
+
* @param {*} [options] Override http request option.
|
|
1937
|
+
* @throws {RequiredError}
|
|
1938
|
+
*/
|
|
1939
|
+
amendOrder(requestParameters, options) {
|
|
1940
|
+
return localVarFp.amendOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, requestParameters.amendOrderRequest, options).then((request) => request(axios, basePath));
|
|
1941
|
+
},
|
|
1792
1942
|
/**
|
|
1793
1943
|
*
|
|
1794
1944
|
* @summary Confirm order
|
|
@@ -1879,6 +2029,16 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
1879
2029
|
retryPlatformPayment(requestParameters, options) {
|
|
1880
2030
|
return localVarFp.retryPlatformPayment(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
1881
2031
|
},
|
|
2032
|
+
/**
|
|
2033
|
+
*
|
|
2034
|
+
* @summary Return the contents of an order for a refund or exchange
|
|
2035
|
+
* @param {OrdersApiReturnOrderRequest} requestParameters Request parameters.
|
|
2036
|
+
* @param {*} [options] Override http request option.
|
|
2037
|
+
* @throws {RequiredError}
|
|
2038
|
+
*/
|
|
2039
|
+
returnOrder(requestParameters, options) {
|
|
2040
|
+
return localVarFp.returnOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, requestParameters.returnOrderRequest, options).then((request) => request(axios, basePath));
|
|
2041
|
+
},
|
|
1882
2042
|
/**
|
|
1883
2043
|
* Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
|
|
1884
2044
|
* @summary Send order receipt
|
|
@@ -1908,6 +2068,17 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
1908
2068
|
* @extends {BaseAPI}
|
|
1909
2069
|
*/
|
|
1910
2070
|
export class OrdersApi extends BaseAPI {
|
|
2071
|
+
/**
|
|
2072
|
+
*
|
|
2073
|
+
* @summary Amend the contents of an order
|
|
2074
|
+
* @param {OrdersApiAmendOrderRequest} requestParameters Request parameters.
|
|
2075
|
+
* @param {*} [options] Override http request option.
|
|
2076
|
+
* @throws {RequiredError}
|
|
2077
|
+
* @memberof OrdersApi
|
|
2078
|
+
*/
|
|
2079
|
+
amendOrder(requestParameters, options) {
|
|
2080
|
+
return OrdersApiFp(this.configuration).amendOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, requestParameters.amendOrderRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2081
|
+
}
|
|
1911
2082
|
/**
|
|
1912
2083
|
*
|
|
1913
2084
|
* @summary Confirm order
|
|
@@ -2007,6 +2178,17 @@ export class OrdersApi extends BaseAPI {
|
|
|
2007
2178
|
retryPlatformPayment(requestParameters, options) {
|
|
2008
2179
|
return OrdersApiFp(this.configuration).retryPlatformPayment(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
2009
2180
|
}
|
|
2181
|
+
/**
|
|
2182
|
+
*
|
|
2183
|
+
* @summary Return the contents of an order for a refund or exchange
|
|
2184
|
+
* @param {OrdersApiReturnOrderRequest} requestParameters Request parameters.
|
|
2185
|
+
* @param {*} [options] Override http request option.
|
|
2186
|
+
* @throws {RequiredError}
|
|
2187
|
+
* @memberof OrdersApi
|
|
2188
|
+
*/
|
|
2189
|
+
returnOrder(requestParameters, options) {
|
|
2190
|
+
return OrdersApiFp(this.configuration).returnOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, requestParameters.returnOrderRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2191
|
+
}
|
|
2010
2192
|
/**
|
|
2011
2193
|
* Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
|
|
2012
2194
|
* @summary Send order receipt
|
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
package/dist/esm/index.js
CHANGED
package/dist/index.d.ts
CHANGED
package/dist/index.js
CHANGED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# AmendOrderRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**amendments** | [**Array<AmendOrderRequestAmendmentsInner>**](AmendOrderRequestAmendmentsInner.md) | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { AmendOrderRequest } from '@teemill/platform';
|
|
14
|
+
|
|
15
|
+
const instance: AmendOrderRequest = {
|
|
16
|
+
amendments,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|