@teemill/platform 0.17.0 → 0.19.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 +4 -2
- package/api.ts +143 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +88 -1
- package/dist/api.js +84 -1
- 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 +88 -1
- package/dist/esm/api.js +84 -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/Coupon.md +22 -0
- package/docs/Order.md +2 -0
- package/docs/OrdersApi.md +63 -0
- 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.19.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.19.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -59,6 +59,7 @@ Class | Method | HTTP request | Description
|
|
|
59
59
|
*OrdersApi* | [**getOrder**](docs/OrdersApi.md#getorder) | **GET** /v1/platform/{platformId}/orders/{orderId} | Get order
|
|
60
60
|
*OrdersApi* | [**listAvailableFulfillers**](docs/OrdersApi.md#listavailablefulfillers) | **GET** /v1/platform/{platformId}/fulfillments/{fulfillmentId}/available-fulfillers | List available fulfillers
|
|
61
61
|
*OrdersApi* | [**listOrders**](docs/OrdersApi.md#listorders) | **GET** /v1/platform/{platformId}/orders | List orders
|
|
62
|
+
*OrdersApi* | [**retryPlatformPayment**](docs/OrdersApi.md#retryplatformpayment) | **POST** /v1/platform/{platformId}/orders/{orderId}/retryPlatformPayment | Retry
|
|
62
63
|
*OrdersApi* | [**updateFulfillment**](docs/OrdersApi.md#updatefulfillment) | **PATCH** /v1/platform/{platformId}/fulfillments/{fulfillmentId} | Update fulfillment
|
|
63
64
|
*PaymentApi* | [**authorizeStripe**](docs/PaymentApi.md#authorizestripe) | **GET** /v1/platform/payment/stripe/authorize | Authorize Stripe
|
|
64
65
|
*PaymentApi* | [**deauthorizeStripe**](docs/PaymentApi.md#deauthorizestripe) | **DELETE** /v1/platform/payment/stripe/deauthorize | Deauthorize Stripe
|
|
@@ -77,6 +78,7 @@ Class | Method | HTTP request | Description
|
|
|
77
78
|
- [ApiError](docs/ApiError.md)
|
|
78
79
|
- [AuthorizeStripe200Response](docs/AuthorizeStripe200Response.md)
|
|
79
80
|
- [ContactInformation](docs/ContactInformation.md)
|
|
81
|
+
- [Coupon](docs/Coupon.md)
|
|
80
82
|
- [Customer](docs/Customer.md)
|
|
81
83
|
- [CustomersResponse](docs/CustomersResponse.md)
|
|
82
84
|
- [DeliveryEstimates](docs/DeliveryEstimates.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.19.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -129,6 +129,25 @@ export interface ContactInformation {
|
|
|
129
129
|
*/
|
|
130
130
|
'phone'?: string | null;
|
|
131
131
|
}
|
|
132
|
+
/**
|
|
133
|
+
*
|
|
134
|
+
* @export
|
|
135
|
+
* @interface Coupon
|
|
136
|
+
*/
|
|
137
|
+
export interface Coupon {
|
|
138
|
+
/**
|
|
139
|
+
* Unique object identifier
|
|
140
|
+
* @type {string}
|
|
141
|
+
* @memberof Coupon
|
|
142
|
+
*/
|
|
143
|
+
'id': string;
|
|
144
|
+
/**
|
|
145
|
+
*
|
|
146
|
+
* @type {string}
|
|
147
|
+
* @memberof Coupon
|
|
148
|
+
*/
|
|
149
|
+
'code': string;
|
|
150
|
+
}
|
|
132
151
|
/**
|
|
133
152
|
* The customer that has placed an order on your platform
|
|
134
153
|
* @export
|
|
@@ -521,6 +540,12 @@ export interface Order {
|
|
|
521
540
|
* @memberof Order
|
|
522
541
|
*/
|
|
523
542
|
'discountPrice'?: Price;
|
|
543
|
+
/**
|
|
544
|
+
*
|
|
545
|
+
* @type {Coupon}
|
|
546
|
+
* @memberof Order
|
|
547
|
+
*/
|
|
548
|
+
'coupon'?: Coupon | null;
|
|
524
549
|
/**
|
|
525
550
|
*
|
|
526
551
|
* @type {Price}
|
|
@@ -2186,6 +2211,58 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
2186
2211
|
|
|
2187
2212
|
|
|
2188
2213
|
|
|
2214
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2215
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2216
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2217
|
+
|
|
2218
|
+
return {
|
|
2219
|
+
url: toPathString(localVarUrlObj),
|
|
2220
|
+
options: localVarRequestOptions,
|
|
2221
|
+
};
|
|
2222
|
+
},
|
|
2223
|
+
/**
|
|
2224
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
2225
|
+
* @summary Retry
|
|
2226
|
+
* @param {string} project Project unique identifier
|
|
2227
|
+
* @param {string} platformId The platform identifier
|
|
2228
|
+
* @param {string} orderId The order identifier
|
|
2229
|
+
* @param {*} [options] Override http request option.
|
|
2230
|
+
* @throws {RequiredError}
|
|
2231
|
+
*/
|
|
2232
|
+
retryPlatformPayment: async (project: string, platformId: string, orderId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2233
|
+
// verify required parameter 'project' is not null or undefined
|
|
2234
|
+
assertParamExists('retryPlatformPayment', 'project', project)
|
|
2235
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
2236
|
+
assertParamExists('retryPlatformPayment', 'platformId', platformId)
|
|
2237
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
2238
|
+
assertParamExists('retryPlatformPayment', 'orderId', orderId)
|
|
2239
|
+
const localVarPath = `/v1/platform/{platformId}/orders/{orderId}/retryPlatformPayment`
|
|
2240
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
2241
|
+
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
|
|
2242
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2243
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2244
|
+
let baseOptions;
|
|
2245
|
+
if (configuration) {
|
|
2246
|
+
baseOptions = configuration.baseOptions;
|
|
2247
|
+
}
|
|
2248
|
+
|
|
2249
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
2250
|
+
const localVarHeaderParameter = {} as any;
|
|
2251
|
+
const localVarQueryParameter = {} as any;
|
|
2252
|
+
|
|
2253
|
+
// authentication session-oauth required
|
|
2254
|
+
// oauth required
|
|
2255
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
2256
|
+
|
|
2257
|
+
// authentication api-key required
|
|
2258
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
2259
|
+
|
|
2260
|
+
if (project !== undefined) {
|
|
2261
|
+
localVarQueryParameter['project'] = project;
|
|
2262
|
+
}
|
|
2263
|
+
|
|
2264
|
+
|
|
2265
|
+
|
|
2189
2266
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2190
2267
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2191
2268
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -2345,6 +2422,21 @@ export const OrdersApiFp = function(configuration?: Configuration) {
|
|
|
2345
2422
|
const localVarOperationServerBasePath = operationServerMap['OrdersApi.listOrders']?.[localVarOperationServerIndex]?.url;
|
|
2346
2423
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2347
2424
|
},
|
|
2425
|
+
/**
|
|
2426
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
2427
|
+
* @summary Retry
|
|
2428
|
+
* @param {string} project Project unique identifier
|
|
2429
|
+
* @param {string} platformId The platform identifier
|
|
2430
|
+
* @param {string} orderId The order identifier
|
|
2431
|
+
* @param {*} [options] Override http request option.
|
|
2432
|
+
* @throws {RequiredError}
|
|
2433
|
+
*/
|
|
2434
|
+
async retryPlatformPayment(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>> {
|
|
2435
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.retryPlatformPayment(project, platformId, orderId, options);
|
|
2436
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2437
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.retryPlatformPayment']?.[localVarOperationServerIndex]?.url;
|
|
2438
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2439
|
+
},
|
|
2348
2440
|
/**
|
|
2349
2441
|
* Update a fulfillment that belongs to an order placed through the platform
|
|
2350
2442
|
* @summary Update fulfillment
|
|
@@ -2421,6 +2513,16 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
|
|
|
2421
2513
|
listOrders(requestParameters: OrdersApiListOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrdersResponse> {
|
|
2422
2514
|
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));
|
|
2423
2515
|
},
|
|
2516
|
+
/**
|
|
2517
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
2518
|
+
* @summary Retry
|
|
2519
|
+
* @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
|
|
2520
|
+
* @param {*} [options] Override http request option.
|
|
2521
|
+
* @throws {RequiredError}
|
|
2522
|
+
*/
|
|
2523
|
+
retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order> {
|
|
2524
|
+
return localVarFp.retryPlatformPayment(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
2525
|
+
},
|
|
2424
2526
|
/**
|
|
2425
2527
|
* Update a fulfillment that belongs to an order placed through the platform
|
|
2426
2528
|
* @summary Update fulfillment
|
|
@@ -2623,6 +2725,34 @@ export interface OrdersApiListOrdersRequest {
|
|
|
2623
2725
|
readonly dateFilterType?: ListOrdersDateFilterTypeEnum
|
|
2624
2726
|
}
|
|
2625
2727
|
|
|
2728
|
+
/**
|
|
2729
|
+
* Request parameters for retryPlatformPayment operation in OrdersApi.
|
|
2730
|
+
* @export
|
|
2731
|
+
* @interface OrdersApiRetryPlatformPaymentRequest
|
|
2732
|
+
*/
|
|
2733
|
+
export interface OrdersApiRetryPlatformPaymentRequest {
|
|
2734
|
+
/**
|
|
2735
|
+
* Project unique identifier
|
|
2736
|
+
* @type {string}
|
|
2737
|
+
* @memberof OrdersApiRetryPlatformPayment
|
|
2738
|
+
*/
|
|
2739
|
+
readonly project: string
|
|
2740
|
+
|
|
2741
|
+
/**
|
|
2742
|
+
* The platform identifier
|
|
2743
|
+
* @type {string}
|
|
2744
|
+
* @memberof OrdersApiRetryPlatformPayment
|
|
2745
|
+
*/
|
|
2746
|
+
readonly platformId: string
|
|
2747
|
+
|
|
2748
|
+
/**
|
|
2749
|
+
* The order identifier
|
|
2750
|
+
* @type {string}
|
|
2751
|
+
* @memberof OrdersApiRetryPlatformPayment
|
|
2752
|
+
*/
|
|
2753
|
+
readonly orderId: string
|
|
2754
|
+
}
|
|
2755
|
+
|
|
2626
2756
|
/**
|
|
2627
2757
|
* Request parameters for updateFulfillment operation in OrdersApi.
|
|
2628
2758
|
* @export
|
|
@@ -2725,6 +2855,18 @@ export class OrdersApi extends BaseAPI {
|
|
|
2725
2855
|
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));
|
|
2726
2856
|
}
|
|
2727
2857
|
|
|
2858
|
+
/**
|
|
2859
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
2860
|
+
* @summary Retry
|
|
2861
|
+
* @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
|
|
2862
|
+
* @param {*} [options] Override http request option.
|
|
2863
|
+
* @throws {RequiredError}
|
|
2864
|
+
* @memberof OrdersApi
|
|
2865
|
+
*/
|
|
2866
|
+
public retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig) {
|
|
2867
|
+
return OrdersApiFp(this.configuration).retryPlatformPayment(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
2868
|
+
}
|
|
2869
|
+
|
|
2728
2870
|
/**
|
|
2729
2871
|
* Update a fulfillment that belongs to an order placed through the platform
|
|
2730
2872
|
* @summary Update fulfillment
|
package/base.ts
CHANGED
package/common.ts
CHANGED
package/configuration.ts
CHANGED
package/dist/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.19.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -119,6 +119,25 @@ export interface ContactInformation {
|
|
|
119
119
|
*/
|
|
120
120
|
'phone'?: string | null;
|
|
121
121
|
}
|
|
122
|
+
/**
|
|
123
|
+
*
|
|
124
|
+
* @export
|
|
125
|
+
* @interface Coupon
|
|
126
|
+
*/
|
|
127
|
+
export interface Coupon {
|
|
128
|
+
/**
|
|
129
|
+
* Unique object identifier
|
|
130
|
+
* @type {string}
|
|
131
|
+
* @memberof Coupon
|
|
132
|
+
*/
|
|
133
|
+
'id': string;
|
|
134
|
+
/**
|
|
135
|
+
*
|
|
136
|
+
* @type {string}
|
|
137
|
+
* @memberof Coupon
|
|
138
|
+
*/
|
|
139
|
+
'code': string;
|
|
140
|
+
}
|
|
122
141
|
/**
|
|
123
142
|
* The customer that has placed an order on your platform
|
|
124
143
|
* @export
|
|
@@ -509,6 +528,12 @@ export interface Order {
|
|
|
509
528
|
* @memberof Order
|
|
510
529
|
*/
|
|
511
530
|
'discountPrice'?: Price;
|
|
531
|
+
/**
|
|
532
|
+
*
|
|
533
|
+
* @type {Coupon}
|
|
534
|
+
* @memberof Order
|
|
535
|
+
*/
|
|
536
|
+
'coupon'?: Coupon | null;
|
|
512
537
|
/**
|
|
513
538
|
*
|
|
514
539
|
* @type {Price}
|
|
@@ -1681,6 +1706,16 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
1681
1706
|
* @throws {RequiredError}
|
|
1682
1707
|
*/
|
|
1683
1708
|
listOrders: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, dateFilterType?: ListOrdersDateFilterTypeEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1709
|
+
/**
|
|
1710
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
1711
|
+
* @summary Retry
|
|
1712
|
+
* @param {string} project Project unique identifier
|
|
1713
|
+
* @param {string} platformId The platform identifier
|
|
1714
|
+
* @param {string} orderId The order identifier
|
|
1715
|
+
* @param {*} [options] Override http request option.
|
|
1716
|
+
* @throws {RequiredError}
|
|
1717
|
+
*/
|
|
1718
|
+
retryPlatformPayment: (project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1684
1719
|
/**
|
|
1685
1720
|
* Update a fulfillment that belongs to an order placed through the platform
|
|
1686
1721
|
* @summary Update fulfillment
|
|
@@ -1755,6 +1790,16 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
1755
1790
|
* @throws {RequiredError}
|
|
1756
1791
|
*/
|
|
1757
1792
|
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>>;
|
|
1793
|
+
/**
|
|
1794
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
1795
|
+
* @summary Retry
|
|
1796
|
+
* @param {string} project Project unique identifier
|
|
1797
|
+
* @param {string} platformId The platform identifier
|
|
1798
|
+
* @param {string} orderId The order identifier
|
|
1799
|
+
* @param {*} [options] Override http request option.
|
|
1800
|
+
* @throws {RequiredError}
|
|
1801
|
+
*/
|
|
1802
|
+
retryPlatformPayment(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
|
|
1758
1803
|
/**
|
|
1759
1804
|
* Update a fulfillment that belongs to an order placed through the platform
|
|
1760
1805
|
* @summary Update fulfillment
|
|
@@ -1812,6 +1857,14 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
1812
1857
|
* @throws {RequiredError}
|
|
1813
1858
|
*/
|
|
1814
1859
|
listOrders(requestParameters: OrdersApiListOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrdersResponse>;
|
|
1860
|
+
/**
|
|
1861
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
1862
|
+
* @summary Retry
|
|
1863
|
+
* @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
|
|
1864
|
+
* @param {*} [options] Override http request option.
|
|
1865
|
+
* @throws {RequiredError}
|
|
1866
|
+
*/
|
|
1867
|
+
retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order>;
|
|
1815
1868
|
/**
|
|
1816
1869
|
* Update a fulfillment that belongs to an order placed through the platform
|
|
1817
1870
|
* @summary Update fulfillment
|
|
@@ -1988,6 +2041,31 @@ export interface OrdersApiListOrdersRequest {
|
|
|
1988
2041
|
*/
|
|
1989
2042
|
readonly dateFilterType?: ListOrdersDateFilterTypeEnum;
|
|
1990
2043
|
}
|
|
2044
|
+
/**
|
|
2045
|
+
* Request parameters for retryPlatformPayment operation in OrdersApi.
|
|
2046
|
+
* @export
|
|
2047
|
+
* @interface OrdersApiRetryPlatformPaymentRequest
|
|
2048
|
+
*/
|
|
2049
|
+
export interface OrdersApiRetryPlatformPaymentRequest {
|
|
2050
|
+
/**
|
|
2051
|
+
* Project unique identifier
|
|
2052
|
+
* @type {string}
|
|
2053
|
+
* @memberof OrdersApiRetryPlatformPayment
|
|
2054
|
+
*/
|
|
2055
|
+
readonly project: string;
|
|
2056
|
+
/**
|
|
2057
|
+
* The platform identifier
|
|
2058
|
+
* @type {string}
|
|
2059
|
+
* @memberof OrdersApiRetryPlatformPayment
|
|
2060
|
+
*/
|
|
2061
|
+
readonly platformId: string;
|
|
2062
|
+
/**
|
|
2063
|
+
* The order identifier
|
|
2064
|
+
* @type {string}
|
|
2065
|
+
* @memberof OrdersApiRetryPlatformPayment
|
|
2066
|
+
*/
|
|
2067
|
+
readonly orderId: string;
|
|
2068
|
+
}
|
|
1991
2069
|
/**
|
|
1992
2070
|
* Request parameters for updateFulfillment operation in OrdersApi.
|
|
1993
2071
|
* @export
|
|
@@ -2071,6 +2149,15 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
2071
2149
|
* @memberof OrdersApi
|
|
2072
2150
|
*/
|
|
2073
2151
|
listOrders(requestParameters: OrdersApiListOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrdersResponse, any>>;
|
|
2152
|
+
/**
|
|
2153
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
2154
|
+
* @summary Retry
|
|
2155
|
+
* @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
|
|
2156
|
+
* @param {*} [options] Override http request option.
|
|
2157
|
+
* @throws {RequiredError}
|
|
2158
|
+
* @memberof OrdersApi
|
|
2159
|
+
*/
|
|
2160
|
+
retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
|
|
2074
2161
|
/**
|
|
2075
2162
|
* Update a fulfillment that belongs to an order placed through the platform
|
|
2076
2163
|
* @summary Update fulfillment
|
package/dist/api.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Platform API
|
|
6
6
|
* Manage Your podOS platform
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 0.
|
|
8
|
+
* The version of the OpenAPI document: 0.19.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -687,6 +687,50 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
687
687
|
options: localVarRequestOptions,
|
|
688
688
|
};
|
|
689
689
|
}),
|
|
690
|
+
/**
|
|
691
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
692
|
+
* @summary Retry
|
|
693
|
+
* @param {string} project Project unique identifier
|
|
694
|
+
* @param {string} platformId The platform identifier
|
|
695
|
+
* @param {string} orderId The order identifier
|
|
696
|
+
* @param {*} [options] Override http request option.
|
|
697
|
+
* @throws {RequiredError}
|
|
698
|
+
*/
|
|
699
|
+
retryPlatformPayment: (project_1, platformId_1, orderId_1, ...args_1) => __awaiter(this, [project_1, platformId_1, orderId_1, ...args_1], void 0, function* (project, platformId, orderId, options = {}) {
|
|
700
|
+
// verify required parameter 'project' is not null or undefined
|
|
701
|
+
(0, common_1.assertParamExists)('retryPlatformPayment', 'project', project);
|
|
702
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
703
|
+
(0, common_1.assertParamExists)('retryPlatformPayment', 'platformId', platformId);
|
|
704
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
705
|
+
(0, common_1.assertParamExists)('retryPlatformPayment', 'orderId', orderId);
|
|
706
|
+
const localVarPath = `/v1/platform/{platformId}/orders/{orderId}/retryPlatformPayment`
|
|
707
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
708
|
+
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
|
|
709
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
710
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
711
|
+
let baseOptions;
|
|
712
|
+
if (configuration) {
|
|
713
|
+
baseOptions = configuration.baseOptions;
|
|
714
|
+
}
|
|
715
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
716
|
+
const localVarHeaderParameter = {};
|
|
717
|
+
const localVarQueryParameter = {};
|
|
718
|
+
// authentication session-oauth required
|
|
719
|
+
// oauth required
|
|
720
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
721
|
+
// authentication api-key required
|
|
722
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
723
|
+
if (project !== undefined) {
|
|
724
|
+
localVarQueryParameter['project'] = project;
|
|
725
|
+
}
|
|
726
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
727
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
728
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
729
|
+
return {
|
|
730
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
731
|
+
options: localVarRequestOptions,
|
|
732
|
+
};
|
|
733
|
+
}),
|
|
690
734
|
/**
|
|
691
735
|
* Update a fulfillment that belongs to an order placed through the platform
|
|
692
736
|
* @summary Update fulfillment
|
|
@@ -843,6 +887,24 @@ const OrdersApiFp = function (configuration) {
|
|
|
843
887
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
844
888
|
});
|
|
845
889
|
},
|
|
890
|
+
/**
|
|
891
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
892
|
+
* @summary Retry
|
|
893
|
+
* @param {string} project Project unique identifier
|
|
894
|
+
* @param {string} platformId The platform identifier
|
|
895
|
+
* @param {string} orderId The order identifier
|
|
896
|
+
* @param {*} [options] Override http request option.
|
|
897
|
+
* @throws {RequiredError}
|
|
898
|
+
*/
|
|
899
|
+
retryPlatformPayment(project, platformId, orderId, options) {
|
|
900
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
901
|
+
var _a, _b, _c;
|
|
902
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.retryPlatformPayment(project, platformId, orderId, options);
|
|
903
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
904
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OrdersApi.retryPlatformPayment']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
905
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
906
|
+
});
|
|
907
|
+
},
|
|
846
908
|
/**
|
|
847
909
|
* Update a fulfillment that belongs to an order placed through the platform
|
|
848
910
|
* @summary Update fulfillment
|
|
@@ -922,6 +984,16 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
922
984
|
listOrders(requestParameters, options) {
|
|
923
985
|
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));
|
|
924
986
|
},
|
|
987
|
+
/**
|
|
988
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
989
|
+
* @summary Retry
|
|
990
|
+
* @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
|
|
991
|
+
* @param {*} [options] Override http request option.
|
|
992
|
+
* @throws {RequiredError}
|
|
993
|
+
*/
|
|
994
|
+
retryPlatformPayment(requestParameters, options) {
|
|
995
|
+
return localVarFp.retryPlatformPayment(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
996
|
+
},
|
|
925
997
|
/**
|
|
926
998
|
* Update a fulfillment that belongs to an order placed through the platform
|
|
927
999
|
* @summary Update fulfillment
|
|
@@ -997,6 +1069,17 @@ class OrdersApi extends base_1.BaseAPI {
|
|
|
997
1069
|
listOrders(requestParameters, options) {
|
|
998
1070
|
return (0, exports.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));
|
|
999
1071
|
}
|
|
1072
|
+
/**
|
|
1073
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
1074
|
+
* @summary Retry
|
|
1075
|
+
* @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
|
|
1076
|
+
* @param {*} [options] Override http request option.
|
|
1077
|
+
* @throws {RequiredError}
|
|
1078
|
+
* @memberof OrdersApi
|
|
1079
|
+
*/
|
|
1080
|
+
retryPlatformPayment(requestParameters, options) {
|
|
1081
|
+
return (0, exports.OrdersApiFp)(this.configuration).retryPlatformPayment(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
1082
|
+
}
|
|
1000
1083
|
/**
|
|
1001
1084
|
* Update a fulfillment that belongs to an order placed through the platform
|
|
1002
1085
|
* @summary Update fulfillment
|
package/dist/base.d.ts
CHANGED
package/dist/base.js
CHANGED
package/dist/common.d.ts
CHANGED
package/dist/common.js
CHANGED
package/dist/configuration.d.ts
CHANGED
package/dist/configuration.js
CHANGED
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.19.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -119,6 +119,25 @@ export interface ContactInformation {
|
|
|
119
119
|
*/
|
|
120
120
|
'phone'?: string | null;
|
|
121
121
|
}
|
|
122
|
+
/**
|
|
123
|
+
*
|
|
124
|
+
* @export
|
|
125
|
+
* @interface Coupon
|
|
126
|
+
*/
|
|
127
|
+
export interface Coupon {
|
|
128
|
+
/**
|
|
129
|
+
* Unique object identifier
|
|
130
|
+
* @type {string}
|
|
131
|
+
* @memberof Coupon
|
|
132
|
+
*/
|
|
133
|
+
'id': string;
|
|
134
|
+
/**
|
|
135
|
+
*
|
|
136
|
+
* @type {string}
|
|
137
|
+
* @memberof Coupon
|
|
138
|
+
*/
|
|
139
|
+
'code': string;
|
|
140
|
+
}
|
|
122
141
|
/**
|
|
123
142
|
* The customer that has placed an order on your platform
|
|
124
143
|
* @export
|
|
@@ -509,6 +528,12 @@ export interface Order {
|
|
|
509
528
|
* @memberof Order
|
|
510
529
|
*/
|
|
511
530
|
'discountPrice'?: Price;
|
|
531
|
+
/**
|
|
532
|
+
*
|
|
533
|
+
* @type {Coupon}
|
|
534
|
+
* @memberof Order
|
|
535
|
+
*/
|
|
536
|
+
'coupon'?: Coupon | null;
|
|
512
537
|
/**
|
|
513
538
|
*
|
|
514
539
|
* @type {Price}
|
|
@@ -1681,6 +1706,16 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
1681
1706
|
* @throws {RequiredError}
|
|
1682
1707
|
*/
|
|
1683
1708
|
listOrders: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, dateFilterType?: ListOrdersDateFilterTypeEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1709
|
+
/**
|
|
1710
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
1711
|
+
* @summary Retry
|
|
1712
|
+
* @param {string} project Project unique identifier
|
|
1713
|
+
* @param {string} platformId The platform identifier
|
|
1714
|
+
* @param {string} orderId The order identifier
|
|
1715
|
+
* @param {*} [options] Override http request option.
|
|
1716
|
+
* @throws {RequiredError}
|
|
1717
|
+
*/
|
|
1718
|
+
retryPlatformPayment: (project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1684
1719
|
/**
|
|
1685
1720
|
* Update a fulfillment that belongs to an order placed through the platform
|
|
1686
1721
|
* @summary Update fulfillment
|
|
@@ -1755,6 +1790,16 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
1755
1790
|
* @throws {RequiredError}
|
|
1756
1791
|
*/
|
|
1757
1792
|
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>>;
|
|
1793
|
+
/**
|
|
1794
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
1795
|
+
* @summary Retry
|
|
1796
|
+
* @param {string} project Project unique identifier
|
|
1797
|
+
* @param {string} platformId The platform identifier
|
|
1798
|
+
* @param {string} orderId The order identifier
|
|
1799
|
+
* @param {*} [options] Override http request option.
|
|
1800
|
+
* @throws {RequiredError}
|
|
1801
|
+
*/
|
|
1802
|
+
retryPlatformPayment(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
|
|
1758
1803
|
/**
|
|
1759
1804
|
* Update a fulfillment that belongs to an order placed through the platform
|
|
1760
1805
|
* @summary Update fulfillment
|
|
@@ -1812,6 +1857,14 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
1812
1857
|
* @throws {RequiredError}
|
|
1813
1858
|
*/
|
|
1814
1859
|
listOrders(requestParameters: OrdersApiListOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrdersResponse>;
|
|
1860
|
+
/**
|
|
1861
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
1862
|
+
* @summary Retry
|
|
1863
|
+
* @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
|
|
1864
|
+
* @param {*} [options] Override http request option.
|
|
1865
|
+
* @throws {RequiredError}
|
|
1866
|
+
*/
|
|
1867
|
+
retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order>;
|
|
1815
1868
|
/**
|
|
1816
1869
|
* Update a fulfillment that belongs to an order placed through the platform
|
|
1817
1870
|
* @summary Update fulfillment
|
|
@@ -1988,6 +2041,31 @@ export interface OrdersApiListOrdersRequest {
|
|
|
1988
2041
|
*/
|
|
1989
2042
|
readonly dateFilterType?: ListOrdersDateFilterTypeEnum;
|
|
1990
2043
|
}
|
|
2044
|
+
/**
|
|
2045
|
+
* Request parameters for retryPlatformPayment operation in OrdersApi.
|
|
2046
|
+
* @export
|
|
2047
|
+
* @interface OrdersApiRetryPlatformPaymentRequest
|
|
2048
|
+
*/
|
|
2049
|
+
export interface OrdersApiRetryPlatformPaymentRequest {
|
|
2050
|
+
/**
|
|
2051
|
+
* Project unique identifier
|
|
2052
|
+
* @type {string}
|
|
2053
|
+
* @memberof OrdersApiRetryPlatformPayment
|
|
2054
|
+
*/
|
|
2055
|
+
readonly project: string;
|
|
2056
|
+
/**
|
|
2057
|
+
* The platform identifier
|
|
2058
|
+
* @type {string}
|
|
2059
|
+
* @memberof OrdersApiRetryPlatformPayment
|
|
2060
|
+
*/
|
|
2061
|
+
readonly platformId: string;
|
|
2062
|
+
/**
|
|
2063
|
+
* The order identifier
|
|
2064
|
+
* @type {string}
|
|
2065
|
+
* @memberof OrdersApiRetryPlatformPayment
|
|
2066
|
+
*/
|
|
2067
|
+
readonly orderId: string;
|
|
2068
|
+
}
|
|
1991
2069
|
/**
|
|
1992
2070
|
* Request parameters for updateFulfillment operation in OrdersApi.
|
|
1993
2071
|
* @export
|
|
@@ -2071,6 +2149,15 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
2071
2149
|
* @memberof OrdersApi
|
|
2072
2150
|
*/
|
|
2073
2151
|
listOrders(requestParameters: OrdersApiListOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrdersResponse, any>>;
|
|
2152
|
+
/**
|
|
2153
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
2154
|
+
* @summary Retry
|
|
2155
|
+
* @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
|
|
2156
|
+
* @param {*} [options] Override http request option.
|
|
2157
|
+
* @throws {RequiredError}
|
|
2158
|
+
* @memberof OrdersApi
|
|
2159
|
+
*/
|
|
2160
|
+
retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
|
|
2074
2161
|
/**
|
|
2075
2162
|
* Update a fulfillment that belongs to an order placed through the platform
|
|
2076
2163
|
* @summary Update fulfillment
|
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.19.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -680,6 +680,50 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
680
680
|
options: localVarRequestOptions,
|
|
681
681
|
};
|
|
682
682
|
}),
|
|
683
|
+
/**
|
|
684
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
685
|
+
* @summary Retry
|
|
686
|
+
* @param {string} project Project unique identifier
|
|
687
|
+
* @param {string} platformId The platform identifier
|
|
688
|
+
* @param {string} orderId The order identifier
|
|
689
|
+
* @param {*} [options] Override http request option.
|
|
690
|
+
* @throws {RequiredError}
|
|
691
|
+
*/
|
|
692
|
+
retryPlatformPayment: (project_1, platformId_1, orderId_1, ...args_1) => __awaiter(this, [project_1, platformId_1, orderId_1, ...args_1], void 0, function* (project, platformId, orderId, options = {}) {
|
|
693
|
+
// verify required parameter 'project' is not null or undefined
|
|
694
|
+
assertParamExists('retryPlatformPayment', 'project', project);
|
|
695
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
696
|
+
assertParamExists('retryPlatformPayment', 'platformId', platformId);
|
|
697
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
698
|
+
assertParamExists('retryPlatformPayment', 'orderId', orderId);
|
|
699
|
+
const localVarPath = `/v1/platform/{platformId}/orders/{orderId}/retryPlatformPayment`
|
|
700
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
701
|
+
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
|
|
702
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
703
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
704
|
+
let baseOptions;
|
|
705
|
+
if (configuration) {
|
|
706
|
+
baseOptions = configuration.baseOptions;
|
|
707
|
+
}
|
|
708
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
709
|
+
const localVarHeaderParameter = {};
|
|
710
|
+
const localVarQueryParameter = {};
|
|
711
|
+
// authentication session-oauth required
|
|
712
|
+
// oauth required
|
|
713
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
714
|
+
// authentication api-key required
|
|
715
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
716
|
+
if (project !== undefined) {
|
|
717
|
+
localVarQueryParameter['project'] = project;
|
|
718
|
+
}
|
|
719
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
720
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
721
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
722
|
+
return {
|
|
723
|
+
url: toPathString(localVarUrlObj),
|
|
724
|
+
options: localVarRequestOptions,
|
|
725
|
+
};
|
|
726
|
+
}),
|
|
683
727
|
/**
|
|
684
728
|
* Update a fulfillment that belongs to an order placed through the platform
|
|
685
729
|
* @summary Update fulfillment
|
|
@@ -835,6 +879,24 @@ export const OrdersApiFp = function (configuration) {
|
|
|
835
879
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
836
880
|
});
|
|
837
881
|
},
|
|
882
|
+
/**
|
|
883
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
884
|
+
* @summary Retry
|
|
885
|
+
* @param {string} project Project unique identifier
|
|
886
|
+
* @param {string} platformId The platform identifier
|
|
887
|
+
* @param {string} orderId The order identifier
|
|
888
|
+
* @param {*} [options] Override http request option.
|
|
889
|
+
* @throws {RequiredError}
|
|
890
|
+
*/
|
|
891
|
+
retryPlatformPayment(project, platformId, orderId, options) {
|
|
892
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
893
|
+
var _a, _b, _c;
|
|
894
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.retryPlatformPayment(project, platformId, orderId, options);
|
|
895
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
896
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrdersApi.retryPlatformPayment']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
897
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
898
|
+
});
|
|
899
|
+
},
|
|
838
900
|
/**
|
|
839
901
|
* Update a fulfillment that belongs to an order placed through the platform
|
|
840
902
|
* @summary Update fulfillment
|
|
@@ -913,6 +975,16 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
913
975
|
listOrders(requestParameters, options) {
|
|
914
976
|
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));
|
|
915
977
|
},
|
|
978
|
+
/**
|
|
979
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
980
|
+
* @summary Retry
|
|
981
|
+
* @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
|
|
982
|
+
* @param {*} [options] Override http request option.
|
|
983
|
+
* @throws {RequiredError}
|
|
984
|
+
*/
|
|
985
|
+
retryPlatformPayment(requestParameters, options) {
|
|
986
|
+
return localVarFp.retryPlatformPayment(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
987
|
+
},
|
|
916
988
|
/**
|
|
917
989
|
* Update a fulfillment that belongs to an order placed through the platform
|
|
918
990
|
* @summary Update fulfillment
|
|
@@ -987,6 +1059,17 @@ export class OrdersApi extends BaseAPI {
|
|
|
987
1059
|
listOrders(requestParameters, options) {
|
|
988
1060
|
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));
|
|
989
1061
|
}
|
|
1062
|
+
/**
|
|
1063
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
1064
|
+
* @summary Retry
|
|
1065
|
+
* @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
|
|
1066
|
+
* @param {*} [options] Override http request option.
|
|
1067
|
+
* @throws {RequiredError}
|
|
1068
|
+
* @memberof OrdersApi
|
|
1069
|
+
*/
|
|
1070
|
+
retryPlatformPayment(requestParameters, options) {
|
|
1071
|
+
return OrdersApiFp(this.configuration).retryPlatformPayment(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
1072
|
+
}
|
|
990
1073
|
/**
|
|
991
1074
|
* Update a fulfillment that belongs to an order placed through the platform
|
|
992
1075
|
* @summary Update fulfillment
|
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
package/docs/Coupon.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Coupon
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | Unique object identifier | [default to undefined]
|
|
9
|
+
**code** | **string** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { Coupon } from '@teemill/platform';
|
|
15
|
+
|
|
16
|
+
const instance: Coupon = {
|
|
17
|
+
id,
|
|
18
|
+
code,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/Order.md
CHANGED
|
@@ -19,6 +19,7 @@ Name | Type | Description | Notes
|
|
|
19
19
|
**taxPrice** | [**Price**](Price.md) | | [optional] [default to undefined]
|
|
20
20
|
**subtotalPrice** | [**Price**](Price.md) | | [optional] [default to undefined]
|
|
21
21
|
**discountPrice** | [**Price**](Price.md) | | [optional] [default to undefined]
|
|
22
|
+
**coupon** | [**Coupon**](Coupon.md) | | [optional] [default to undefined]
|
|
22
23
|
**shippingPrice** | [**Price**](Price.md) | | [optional] [default to undefined]
|
|
23
24
|
**origin** | [**Origin**](Origin.md) | | [optional] [default to undefined]
|
|
24
25
|
**statusHistory** | [**Array<StatusHistoryItem>**](StatusHistoryItem.md) | | [optional] [default to undefined]
|
|
@@ -45,6 +46,7 @@ const instance: Order = {
|
|
|
45
46
|
taxPrice,
|
|
46
47
|
subtotalPrice,
|
|
47
48
|
discountPrice,
|
|
49
|
+
coupon,
|
|
48
50
|
shippingPrice,
|
|
49
51
|
origin,
|
|
50
52
|
statusHistory,
|
package/docs/OrdersApi.md
CHANGED
|
@@ -9,6 +9,7 @@ All URIs are relative to *https://localhost:8080*
|
|
|
9
9
|
|[**getOrder**](#getorder) | **GET** /v1/platform/{platformId}/orders/{orderId} | Get order|
|
|
10
10
|
|[**listAvailableFulfillers**](#listavailablefulfillers) | **GET** /v1/platform/{platformId}/fulfillments/{fulfillmentId}/available-fulfillers | List available fulfillers|
|
|
11
11
|
|[**listOrders**](#listorders) | **GET** /v1/platform/{platformId}/orders | List orders|
|
|
12
|
+
|[**retryPlatformPayment**](#retryplatformpayment) | **POST** /v1/platform/{platformId}/orders/{orderId}/retryPlatformPayment | Retry|
|
|
12
13
|
|[**updateFulfillment**](#updatefulfillment) | **PATCH** /v1/platform/{platformId}/fulfillments/{fulfillmentId} | Update fulfillment|
|
|
13
14
|
|
|
14
15
|
# **exportOrders**
|
|
@@ -342,6 +343,68 @@ const { status, data } = await apiInstance.listOrders(
|
|
|
342
343
|
|
|
343
344
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
344
345
|
|
|
346
|
+
# **retryPlatformPayment**
|
|
347
|
+
> Order retryPlatformPayment()
|
|
348
|
+
|
|
349
|
+
Retries failed platform payment, so fulfillment can proceed.
|
|
350
|
+
|
|
351
|
+
### Example
|
|
352
|
+
|
|
353
|
+
```typescript
|
|
354
|
+
import {
|
|
355
|
+
OrdersApi,
|
|
356
|
+
Configuration
|
|
357
|
+
} from '@teemill/platform';
|
|
358
|
+
|
|
359
|
+
const configuration = new Configuration();
|
|
360
|
+
const apiInstance = new OrdersApi(configuration);
|
|
361
|
+
|
|
362
|
+
let project: string; //Project unique identifier (default to undefined)
|
|
363
|
+
let platformId: string; //The platform identifier (default to undefined)
|
|
364
|
+
let orderId: string; //The order identifier (default to undefined)
|
|
365
|
+
|
|
366
|
+
const { status, data } = await apiInstance.retryPlatformPayment(
|
|
367
|
+
project,
|
|
368
|
+
platformId,
|
|
369
|
+
orderId
|
|
370
|
+
);
|
|
371
|
+
```
|
|
372
|
+
|
|
373
|
+
### Parameters
|
|
374
|
+
|
|
375
|
+
|Name | Type | Description | Notes|
|
|
376
|
+
|------------- | ------------- | ------------- | -------------|
|
|
377
|
+
| **project** | [**string**] | Project unique identifier | defaults to undefined|
|
|
378
|
+
| **platformId** | [**string**] | The platform identifier | defaults to undefined|
|
|
379
|
+
| **orderId** | [**string**] | The order identifier | defaults to undefined|
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
### Return type
|
|
383
|
+
|
|
384
|
+
**Order**
|
|
385
|
+
|
|
386
|
+
### Authorization
|
|
387
|
+
|
|
388
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
389
|
+
|
|
390
|
+
### HTTP request headers
|
|
391
|
+
|
|
392
|
+
- **Content-Type**: Not defined
|
|
393
|
+
- **Accept**: application/json
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
### HTTP response details
|
|
397
|
+
| Status code | Description | Response headers |
|
|
398
|
+
|-------------|-------------|------------------|
|
|
399
|
+
|**200** | Order schema | - |
|
|
400
|
+
|**400** | Failed validation | - |
|
|
401
|
+
|**401** | Not authorised to access this resource | - |
|
|
402
|
+
|**403** | Refuse to authorize | - |
|
|
403
|
+
|**404** | Resource not found | - |
|
|
404
|
+
|**500** | Unknown server error | - |
|
|
405
|
+
|
|
406
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
407
|
+
|
|
345
408
|
# **updateFulfillment**
|
|
346
409
|
> Fulfillment updateFulfillment(updateFulfillmentRequest)
|
|
347
410
|
|
package/index.ts
CHANGED