@teemill/orders 1.15.1 → 1.16.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 +73 -2
- package/api.ts +176 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +118 -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 +118 -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/Address.md +35 -0
- package/docs/ApiError.md +22 -0
- package/docs/ConfirmOrderFulfillment.md +24 -0
- package/docs/ConfirmOrderFulfillmentShipment.md +21 -0
- package/docs/ConfirmOrderRequest.md +20 -0
- package/docs/ConfirmOrderValidationError.md +22 -0
- package/docs/ContactInformation.md +23 -0
- package/docs/CreateOrder.md +29 -0
- package/docs/CreateOrderContactInformation.md +23 -0
- package/docs/CustomsInformation.md +27 -0
- package/docs/CustomsInformation1.md +26 -0
- package/docs/DeliveryEstimates.md +24 -0
- package/docs/ExportOrders202Response.md +20 -0
- package/docs/Fulfillment.md +34 -0
- package/docs/FulfillmentFulfiller.md +23 -0
- package/docs/FulfillmentFulfillerLocation.md +22 -0
- package/docs/FulfillmentItem.md +24 -0
- package/docs/Image.md +27 -0
- package/docs/Option.md +22 -0
- package/docs/Order.md +58 -0
- package/docs/OrderItem.md +40 -0
- package/docs/OrderItem1.md +24 -0
- package/docs/OrderItem1RecipientCost.md +22 -0
- package/docs/OrderTracking.md +24 -0
- package/docs/OrdersApi.md +475 -0
- package/docs/OrdersResponse.md +22 -0
- package/docs/Origin.md +22 -0
- package/docs/PaymentAttempt.md +32 -0
- package/docs/Price.md +23 -0
- package/docs/ShippingMethod.md +34 -0
- package/docs/Status.md +18 -0
- package/docs/StatusHistoryItem.md +22 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @teemill/orders@1.
|
|
1
|
+
## @teemill/orders@1.16.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/orders@1.
|
|
39
|
+
npm install @teemill/orders@1.16.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -44,3 +44,74 @@ _unPublished (not recommended):_
|
|
|
44
44
|
```
|
|
45
45
|
npm install PATH_TO_GENERATED_PACKAGE --save
|
|
46
46
|
```
|
|
47
|
+
|
|
48
|
+
### Documentation for API Endpoints
|
|
49
|
+
|
|
50
|
+
All URIs are relative to *https://api.localhost:8080*
|
|
51
|
+
|
|
52
|
+
Class | Method | HTTP request | Description
|
|
53
|
+
------------ | ------------- | ------------- | -------------
|
|
54
|
+
*OrdersApi* | [**cancelOrder**](docs/OrdersApi.md#cancelorder) | **DELETE** /v1/orders/{orderId} | Cancel order
|
|
55
|
+
*OrdersApi* | [**confirmOrder**](docs/OrdersApi.md#confirmorder) | **POST** /v1/orders/{orderId}/confirm | Confirm order
|
|
56
|
+
*OrdersApi* | [**createOrder**](docs/OrdersApi.md#createorder) | **POST** /v1/orders | Create order
|
|
57
|
+
*OrdersApi* | [**exportOrders**](docs/OrdersApi.md#exportorders) | **GET** /v1/orders/export | Export orders
|
|
58
|
+
*OrdersApi* | [**getOrder**](docs/OrdersApi.md#getorder) | **GET** /v1/orders/{orderId} | Get order
|
|
59
|
+
*OrdersApi* | [**getOrders**](docs/OrdersApi.md#getorders) | **GET** /v1/orders | List orders
|
|
60
|
+
*OrdersApi* | [**retryPlatformPayment**](docs/OrdersApi.md#retryplatformpayment) | **POST** /v1/orders/{orderId}/retryPlatformPayment | Retry
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
### Documentation For Models
|
|
64
|
+
|
|
65
|
+
- [Address](docs/Address.md)
|
|
66
|
+
- [ApiError](docs/ApiError.md)
|
|
67
|
+
- [ConfirmOrderFulfillment](docs/ConfirmOrderFulfillment.md)
|
|
68
|
+
- [ConfirmOrderFulfillmentShipment](docs/ConfirmOrderFulfillmentShipment.md)
|
|
69
|
+
- [ConfirmOrderRequest](docs/ConfirmOrderRequest.md)
|
|
70
|
+
- [ConfirmOrderValidationError](docs/ConfirmOrderValidationError.md)
|
|
71
|
+
- [ContactInformation](docs/ContactInformation.md)
|
|
72
|
+
- [CreateOrder](docs/CreateOrder.md)
|
|
73
|
+
- [CreateOrderContactInformation](docs/CreateOrderContactInformation.md)
|
|
74
|
+
- [CustomsInformation](docs/CustomsInformation.md)
|
|
75
|
+
- [CustomsInformation1](docs/CustomsInformation1.md)
|
|
76
|
+
- [DeliveryEstimates](docs/DeliveryEstimates.md)
|
|
77
|
+
- [ExportOrders202Response](docs/ExportOrders202Response.md)
|
|
78
|
+
- [Fulfillment](docs/Fulfillment.md)
|
|
79
|
+
- [FulfillmentFulfiller](docs/FulfillmentFulfiller.md)
|
|
80
|
+
- [FulfillmentFulfillerLocation](docs/FulfillmentFulfillerLocation.md)
|
|
81
|
+
- [FulfillmentItem](docs/FulfillmentItem.md)
|
|
82
|
+
- [Image](docs/Image.md)
|
|
83
|
+
- [Option](docs/Option.md)
|
|
84
|
+
- [Order](docs/Order.md)
|
|
85
|
+
- [OrderItem](docs/OrderItem.md)
|
|
86
|
+
- [OrderItem1](docs/OrderItem1.md)
|
|
87
|
+
- [OrderItem1RecipientCost](docs/OrderItem1RecipientCost.md)
|
|
88
|
+
- [OrderTracking](docs/OrderTracking.md)
|
|
89
|
+
- [OrdersResponse](docs/OrdersResponse.md)
|
|
90
|
+
- [Origin](docs/Origin.md)
|
|
91
|
+
- [PaymentAttempt](docs/PaymentAttempt.md)
|
|
92
|
+
- [Price](docs/Price.md)
|
|
93
|
+
- [ShippingMethod](docs/ShippingMethod.md)
|
|
94
|
+
- [Status](docs/Status.md)
|
|
95
|
+
- [StatusHistoryItem](docs/StatusHistoryItem.md)
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
<a id="documentation-for-authorization"></a>
|
|
99
|
+
## Documentation For Authorization
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
Authentication schemes defined for the API:
|
|
103
|
+
<a id="api-key"></a>
|
|
104
|
+
### api-key
|
|
105
|
+
|
|
106
|
+
- **Type**: API key
|
|
107
|
+
- **API key parameter name**: Authorization
|
|
108
|
+
- **Location**: HTTP header
|
|
109
|
+
|
|
110
|
+
<a id="session-oauth"></a>
|
|
111
|
+
### session-oauth
|
|
112
|
+
|
|
113
|
+
- **Type**: OAuth
|
|
114
|
+
- **Flow**: password
|
|
115
|
+
- **Authorization URL**:
|
|
116
|
+
- **Scopes**: N/A
|
|
117
|
+
|
package/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Orders API
|
|
5
5
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.16.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -649,6 +649,12 @@ export interface Order {
|
|
|
649
649
|
* @memberof Order
|
|
650
650
|
*/
|
|
651
651
|
'statusHistory'?: Array<StatusHistoryItem>;
|
|
652
|
+
/**
|
|
653
|
+
*
|
|
654
|
+
* @type {Array<PaymentAttempt>}
|
|
655
|
+
* @memberof Order
|
|
656
|
+
*/
|
|
657
|
+
'paymentAttempts'?: Array<PaymentAttempt>;
|
|
652
658
|
}
|
|
653
659
|
|
|
654
660
|
|
|
@@ -832,6 +838,57 @@ export interface Origin {
|
|
|
832
838
|
*/
|
|
833
839
|
'isPaid'?: boolean;
|
|
834
840
|
}
|
|
841
|
+
/**
|
|
842
|
+
*
|
|
843
|
+
* @export
|
|
844
|
+
* @interface PaymentAttempt
|
|
845
|
+
*/
|
|
846
|
+
export interface PaymentAttempt {
|
|
847
|
+
/**
|
|
848
|
+
* Unique object identifier
|
|
849
|
+
* @type {string}
|
|
850
|
+
* @memberof PaymentAttempt
|
|
851
|
+
*/
|
|
852
|
+
'id'?: string;
|
|
853
|
+
/**
|
|
854
|
+
* Unique object identifier
|
|
855
|
+
* @type {string}
|
|
856
|
+
* @memberof PaymentAttempt
|
|
857
|
+
*/
|
|
858
|
+
'invoiceId'?: string;
|
|
859
|
+
/**
|
|
860
|
+
*
|
|
861
|
+
* @type {string}
|
|
862
|
+
* @memberof PaymentAttempt
|
|
863
|
+
*/
|
|
864
|
+
'paymentMethodType'?: string;
|
|
865
|
+
/**
|
|
866
|
+
*
|
|
867
|
+
* @type {Status}
|
|
868
|
+
* @memberof PaymentAttempt
|
|
869
|
+
*/
|
|
870
|
+
'status'?: Status;
|
|
871
|
+
/**
|
|
872
|
+
*
|
|
873
|
+
* @type {string}
|
|
874
|
+
* @memberof PaymentAttempt
|
|
875
|
+
*/
|
|
876
|
+
'transactionId'?: string | null;
|
|
877
|
+
/**
|
|
878
|
+
*
|
|
879
|
+
* @type {string}
|
|
880
|
+
* @memberof PaymentAttempt
|
|
881
|
+
*/
|
|
882
|
+
'message'?: string;
|
|
883
|
+
/**
|
|
884
|
+
* ISO 8601 Timestamp
|
|
885
|
+
* @type {string}
|
|
886
|
+
* @memberof PaymentAttempt
|
|
887
|
+
*/
|
|
888
|
+
'createdAt'?: string;
|
|
889
|
+
}
|
|
890
|
+
|
|
891
|
+
|
|
835
892
|
/**
|
|
836
893
|
* Standard price definition that defines the amount and currency.
|
|
837
894
|
* @export
|
|
@@ -1321,6 +1378,59 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
1321
1378
|
|
|
1322
1379
|
|
|
1323
1380
|
|
|
1381
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1382
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1383
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1384
|
+
|
|
1385
|
+
return {
|
|
1386
|
+
url: toPathString(localVarUrlObj),
|
|
1387
|
+
options: localVarRequestOptions,
|
|
1388
|
+
};
|
|
1389
|
+
},
|
|
1390
|
+
/**
|
|
1391
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
1392
|
+
* @summary Retry
|
|
1393
|
+
* @param {string} project What project it is
|
|
1394
|
+
* @param {string} orderId Unique identifier of an order
|
|
1395
|
+
* @param {string} [fields] Specifies which fields to return, separated by commas
|
|
1396
|
+
* @param {*} [options] Override http request option.
|
|
1397
|
+
* @throws {RequiredError}
|
|
1398
|
+
*/
|
|
1399
|
+
retryPlatformPayment: async (project: string, orderId: string, fields?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1400
|
+
// verify required parameter 'project' is not null or undefined
|
|
1401
|
+
assertParamExists('retryPlatformPayment', 'project', project)
|
|
1402
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
1403
|
+
assertParamExists('retryPlatformPayment', 'orderId', orderId)
|
|
1404
|
+
const localVarPath = `/v1/orders/{orderId}/retryPlatformPayment`
|
|
1405
|
+
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
|
|
1406
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1407
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1408
|
+
let baseOptions;
|
|
1409
|
+
if (configuration) {
|
|
1410
|
+
baseOptions = configuration.baseOptions;
|
|
1411
|
+
}
|
|
1412
|
+
|
|
1413
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
1414
|
+
const localVarHeaderParameter = {} as any;
|
|
1415
|
+
const localVarQueryParameter = {} as any;
|
|
1416
|
+
|
|
1417
|
+
// authentication session-oauth required
|
|
1418
|
+
// oauth required
|
|
1419
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
1420
|
+
|
|
1421
|
+
// authentication api-key required
|
|
1422
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
1423
|
+
|
|
1424
|
+
if (project !== undefined) {
|
|
1425
|
+
localVarQueryParameter['project'] = project;
|
|
1426
|
+
}
|
|
1427
|
+
|
|
1428
|
+
if (fields !== undefined) {
|
|
1429
|
+
localVarQueryParameter['fields'] = fields;
|
|
1430
|
+
}
|
|
1431
|
+
|
|
1432
|
+
|
|
1433
|
+
|
|
1324
1434
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1325
1435
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1326
1436
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -1439,6 +1549,21 @@ export const OrdersApiFp = function(configuration?: Configuration) {
|
|
|
1439
1549
|
const localVarOperationServerBasePath = operationServerMap['OrdersApi.getOrders']?.[localVarOperationServerIndex]?.url;
|
|
1440
1550
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1441
1551
|
},
|
|
1552
|
+
/**
|
|
1553
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
1554
|
+
* @summary Retry
|
|
1555
|
+
* @param {string} project What project it is
|
|
1556
|
+
* @param {string} orderId Unique identifier of an order
|
|
1557
|
+
* @param {string} [fields] Specifies which fields to return, separated by commas
|
|
1558
|
+
* @param {*} [options] Override http request option.
|
|
1559
|
+
* @throws {RequiredError}
|
|
1560
|
+
*/
|
|
1561
|
+
async retryPlatformPayment(project: string, orderId: string, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>> {
|
|
1562
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.retryPlatformPayment(project, orderId, fields, options);
|
|
1563
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1564
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.retryPlatformPayment']?.[localVarOperationServerIndex]?.url;
|
|
1565
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1566
|
+
},
|
|
1442
1567
|
}
|
|
1443
1568
|
};
|
|
1444
1569
|
|
|
@@ -1509,6 +1634,16 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
|
|
|
1509
1634
|
getOrders(requestParameters: OrdersApiGetOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrdersResponse> {
|
|
1510
1635
|
return localVarFp.getOrders(requestParameters.project, requestParameters.fields, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.ids, requestParameters.statuses, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, options).then((request) => request(axios, basePath));
|
|
1511
1636
|
},
|
|
1637
|
+
/**
|
|
1638
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
1639
|
+
* @summary Retry
|
|
1640
|
+
* @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
|
|
1641
|
+
* @param {*} [options] Override http request option.
|
|
1642
|
+
* @throws {RequiredError}
|
|
1643
|
+
*/
|
|
1644
|
+
retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order> {
|
|
1645
|
+
return localVarFp.retryPlatformPayment(requestParameters.project, requestParameters.orderId, requestParameters.fields, options).then((request) => request(axios, basePath));
|
|
1646
|
+
},
|
|
1512
1647
|
};
|
|
1513
1648
|
};
|
|
1514
1649
|
|
|
@@ -1743,6 +1878,34 @@ export interface OrdersApiGetOrdersRequest {
|
|
|
1743
1878
|
readonly dateFilterType?: GetOrdersDateFilterTypeEnum
|
|
1744
1879
|
}
|
|
1745
1880
|
|
|
1881
|
+
/**
|
|
1882
|
+
* Request parameters for retryPlatformPayment operation in OrdersApi.
|
|
1883
|
+
* @export
|
|
1884
|
+
* @interface OrdersApiRetryPlatformPaymentRequest
|
|
1885
|
+
*/
|
|
1886
|
+
export interface OrdersApiRetryPlatformPaymentRequest {
|
|
1887
|
+
/**
|
|
1888
|
+
* What project it is
|
|
1889
|
+
* @type {string}
|
|
1890
|
+
* @memberof OrdersApiRetryPlatformPayment
|
|
1891
|
+
*/
|
|
1892
|
+
readonly project: string
|
|
1893
|
+
|
|
1894
|
+
/**
|
|
1895
|
+
* Unique identifier of an order
|
|
1896
|
+
* @type {string}
|
|
1897
|
+
* @memberof OrdersApiRetryPlatformPayment
|
|
1898
|
+
*/
|
|
1899
|
+
readonly orderId: string
|
|
1900
|
+
|
|
1901
|
+
/**
|
|
1902
|
+
* Specifies which fields to return, separated by commas
|
|
1903
|
+
* @type {string}
|
|
1904
|
+
* @memberof OrdersApiRetryPlatformPayment
|
|
1905
|
+
*/
|
|
1906
|
+
readonly fields?: string
|
|
1907
|
+
}
|
|
1908
|
+
|
|
1746
1909
|
/**
|
|
1747
1910
|
* OrdersApi - object-oriented interface
|
|
1748
1911
|
* @export
|
|
@@ -1821,6 +1984,18 @@ export class OrdersApi extends BaseAPI {
|
|
|
1821
1984
|
public getOrders(requestParameters: OrdersApiGetOrdersRequest, options?: RawAxiosRequestConfig) {
|
|
1822
1985
|
return OrdersApiFp(this.configuration).getOrders(requestParameters.project, requestParameters.fields, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.ids, requestParameters.statuses, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, options).then((request) => request(this.axios, this.basePath));
|
|
1823
1986
|
}
|
|
1987
|
+
|
|
1988
|
+
/**
|
|
1989
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
1990
|
+
* @summary Retry
|
|
1991
|
+
* @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
|
|
1992
|
+
* @param {*} [options] Override http request option.
|
|
1993
|
+
* @throws {RequiredError}
|
|
1994
|
+
* @memberof OrdersApi
|
|
1995
|
+
*/
|
|
1996
|
+
public retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig) {
|
|
1997
|
+
return OrdersApiFp(this.configuration).retryPlatformPayment(requestParameters.project, requestParameters.orderId, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
|
|
1998
|
+
}
|
|
1824
1999
|
}
|
|
1825
2000
|
|
|
1826
2001
|
/**
|
package/base.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Orders API
|
|
5
5
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.16.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/common.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Orders API
|
|
5
5
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.16.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/configuration.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Orders API
|
|
5
5
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.16.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Orders API
|
|
3
3
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.16.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -631,6 +631,12 @@ export interface Order {
|
|
|
631
631
|
* @memberof Order
|
|
632
632
|
*/
|
|
633
633
|
'statusHistory'?: Array<StatusHistoryItem>;
|
|
634
|
+
/**
|
|
635
|
+
*
|
|
636
|
+
* @type {Array<PaymentAttempt>}
|
|
637
|
+
* @memberof Order
|
|
638
|
+
*/
|
|
639
|
+
'paymentAttempts'?: Array<PaymentAttempt>;
|
|
634
640
|
}
|
|
635
641
|
/**
|
|
636
642
|
*
|
|
@@ -812,6 +818,55 @@ export interface Origin {
|
|
|
812
818
|
*/
|
|
813
819
|
'isPaid'?: boolean;
|
|
814
820
|
}
|
|
821
|
+
/**
|
|
822
|
+
*
|
|
823
|
+
* @export
|
|
824
|
+
* @interface PaymentAttempt
|
|
825
|
+
*/
|
|
826
|
+
export interface PaymentAttempt {
|
|
827
|
+
/**
|
|
828
|
+
* Unique object identifier
|
|
829
|
+
* @type {string}
|
|
830
|
+
* @memberof PaymentAttempt
|
|
831
|
+
*/
|
|
832
|
+
'id'?: string;
|
|
833
|
+
/**
|
|
834
|
+
* Unique object identifier
|
|
835
|
+
* @type {string}
|
|
836
|
+
* @memberof PaymentAttempt
|
|
837
|
+
*/
|
|
838
|
+
'invoiceId'?: string;
|
|
839
|
+
/**
|
|
840
|
+
*
|
|
841
|
+
* @type {string}
|
|
842
|
+
* @memberof PaymentAttempt
|
|
843
|
+
*/
|
|
844
|
+
'paymentMethodType'?: string;
|
|
845
|
+
/**
|
|
846
|
+
*
|
|
847
|
+
* @type {Status}
|
|
848
|
+
* @memberof PaymentAttempt
|
|
849
|
+
*/
|
|
850
|
+
'status'?: Status;
|
|
851
|
+
/**
|
|
852
|
+
*
|
|
853
|
+
* @type {string}
|
|
854
|
+
* @memberof PaymentAttempt
|
|
855
|
+
*/
|
|
856
|
+
'transactionId'?: string | null;
|
|
857
|
+
/**
|
|
858
|
+
*
|
|
859
|
+
* @type {string}
|
|
860
|
+
* @memberof PaymentAttempt
|
|
861
|
+
*/
|
|
862
|
+
'message'?: string;
|
|
863
|
+
/**
|
|
864
|
+
* ISO 8601 Timestamp
|
|
865
|
+
* @type {string}
|
|
866
|
+
* @memberof PaymentAttempt
|
|
867
|
+
*/
|
|
868
|
+
'createdAt'?: string;
|
|
869
|
+
}
|
|
815
870
|
/**
|
|
816
871
|
* Standard price definition that defines the amount and currency.
|
|
817
872
|
* @export
|
|
@@ -993,6 +1048,16 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
993
1048
|
* @throws {RequiredError}
|
|
994
1049
|
*/
|
|
995
1050
|
getOrders: (project: string, fields?: string, pageToken?: number, pageSize?: number, search?: string, ids?: Array<string>, statuses?: Array<Status>, start?: string, end?: string, dateFilterType?: GetOrdersDateFilterTypeEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1051
|
+
/**
|
|
1052
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
1053
|
+
* @summary Retry
|
|
1054
|
+
* @param {string} project What project it is
|
|
1055
|
+
* @param {string} orderId Unique identifier of an order
|
|
1056
|
+
* @param {string} [fields] Specifies which fields to return, separated by commas
|
|
1057
|
+
* @param {*} [options] Override http request option.
|
|
1058
|
+
* @throws {RequiredError}
|
|
1059
|
+
*/
|
|
1060
|
+
retryPlatformPayment: (project: string, orderId: string, fields?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
996
1061
|
};
|
|
997
1062
|
/**
|
|
998
1063
|
* OrdersApi - functional programming interface
|
|
@@ -1068,6 +1133,16 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
1068
1133
|
* @throws {RequiredError}
|
|
1069
1134
|
*/
|
|
1070
1135
|
getOrders(project: string, fields?: string, pageToken?: number, pageSize?: number, search?: string, ids?: Array<string>, statuses?: Array<Status>, start?: string, end?: string, dateFilterType?: GetOrdersDateFilterTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrdersResponse>>;
|
|
1136
|
+
/**
|
|
1137
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
1138
|
+
* @summary Retry
|
|
1139
|
+
* @param {string} project What project it is
|
|
1140
|
+
* @param {string} orderId Unique identifier of an order
|
|
1141
|
+
* @param {string} [fields] Specifies which fields to return, separated by commas
|
|
1142
|
+
* @param {*} [options] Override http request option.
|
|
1143
|
+
* @throws {RequiredError}
|
|
1144
|
+
*/
|
|
1145
|
+
retryPlatformPayment(project: string, orderId: string, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
|
|
1071
1146
|
};
|
|
1072
1147
|
/**
|
|
1073
1148
|
* OrdersApi - factory interface
|
|
@@ -1122,6 +1197,14 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
1122
1197
|
* @throws {RequiredError}
|
|
1123
1198
|
*/
|
|
1124
1199
|
getOrders(requestParameters: OrdersApiGetOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrdersResponse>;
|
|
1200
|
+
/**
|
|
1201
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
1202
|
+
* @summary Retry
|
|
1203
|
+
* @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
|
|
1204
|
+
* @param {*} [options] Override http request option.
|
|
1205
|
+
* @throws {RequiredError}
|
|
1206
|
+
*/
|
|
1207
|
+
retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order>;
|
|
1125
1208
|
};
|
|
1126
1209
|
/**
|
|
1127
1210
|
* Request parameters for cancelOrder operation in OrdersApi.
|
|
@@ -1327,6 +1410,31 @@ export interface OrdersApiGetOrdersRequest {
|
|
|
1327
1410
|
*/
|
|
1328
1411
|
readonly dateFilterType?: GetOrdersDateFilterTypeEnum;
|
|
1329
1412
|
}
|
|
1413
|
+
/**
|
|
1414
|
+
* Request parameters for retryPlatformPayment operation in OrdersApi.
|
|
1415
|
+
* @export
|
|
1416
|
+
* @interface OrdersApiRetryPlatformPaymentRequest
|
|
1417
|
+
*/
|
|
1418
|
+
export interface OrdersApiRetryPlatformPaymentRequest {
|
|
1419
|
+
/**
|
|
1420
|
+
* What project it is
|
|
1421
|
+
* @type {string}
|
|
1422
|
+
* @memberof OrdersApiRetryPlatformPayment
|
|
1423
|
+
*/
|
|
1424
|
+
readonly project: string;
|
|
1425
|
+
/**
|
|
1426
|
+
* Unique identifier of an order
|
|
1427
|
+
* @type {string}
|
|
1428
|
+
* @memberof OrdersApiRetryPlatformPayment
|
|
1429
|
+
*/
|
|
1430
|
+
readonly orderId: string;
|
|
1431
|
+
/**
|
|
1432
|
+
* Specifies which fields to return, separated by commas
|
|
1433
|
+
* @type {string}
|
|
1434
|
+
* @memberof OrdersApiRetryPlatformPayment
|
|
1435
|
+
*/
|
|
1436
|
+
readonly fields?: string;
|
|
1437
|
+
}
|
|
1330
1438
|
/**
|
|
1331
1439
|
* OrdersApi - object-oriented interface
|
|
1332
1440
|
* @export
|
|
@@ -1388,6 +1496,15 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
1388
1496
|
* @memberof OrdersApi
|
|
1389
1497
|
*/
|
|
1390
1498
|
getOrders(requestParameters: OrdersApiGetOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrdersResponse, any>>;
|
|
1499
|
+
/**
|
|
1500
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
1501
|
+
* @summary Retry
|
|
1502
|
+
* @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
|
|
1503
|
+
* @param {*} [options] Override http request option.
|
|
1504
|
+
* @throws {RequiredError}
|
|
1505
|
+
* @memberof OrdersApi
|
|
1506
|
+
*/
|
|
1507
|
+
retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
|
|
1391
1508
|
}
|
|
1392
1509
|
/**
|
|
1393
1510
|
* @export
|
package/dist/api.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Orders API
|
|
6
6
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.16.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -369,6 +369,50 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
369
369
|
options: localVarRequestOptions,
|
|
370
370
|
};
|
|
371
371
|
}),
|
|
372
|
+
/**
|
|
373
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
374
|
+
* @summary Retry
|
|
375
|
+
* @param {string} project What project it is
|
|
376
|
+
* @param {string} orderId Unique identifier of an order
|
|
377
|
+
* @param {string} [fields] Specifies which fields to return, separated by commas
|
|
378
|
+
* @param {*} [options] Override http request option.
|
|
379
|
+
* @throws {RequiredError}
|
|
380
|
+
*/
|
|
381
|
+
retryPlatformPayment: (project_1, orderId_1, fields_1, ...args_1) => __awaiter(this, [project_1, orderId_1, fields_1, ...args_1], void 0, function* (project, orderId, fields, options = {}) {
|
|
382
|
+
// verify required parameter 'project' is not null or undefined
|
|
383
|
+
(0, common_1.assertParamExists)('retryPlatformPayment', 'project', project);
|
|
384
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
385
|
+
(0, common_1.assertParamExists)('retryPlatformPayment', 'orderId', orderId);
|
|
386
|
+
const localVarPath = `/v1/orders/{orderId}/retryPlatformPayment`
|
|
387
|
+
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
|
|
388
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
389
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
390
|
+
let baseOptions;
|
|
391
|
+
if (configuration) {
|
|
392
|
+
baseOptions = configuration.baseOptions;
|
|
393
|
+
}
|
|
394
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
395
|
+
const localVarHeaderParameter = {};
|
|
396
|
+
const localVarQueryParameter = {};
|
|
397
|
+
// authentication session-oauth required
|
|
398
|
+
// oauth required
|
|
399
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
400
|
+
// authentication api-key required
|
|
401
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
402
|
+
if (project !== undefined) {
|
|
403
|
+
localVarQueryParameter['project'] = project;
|
|
404
|
+
}
|
|
405
|
+
if (fields !== undefined) {
|
|
406
|
+
localVarQueryParameter['fields'] = fields;
|
|
407
|
+
}
|
|
408
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
409
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
410
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
411
|
+
return {
|
|
412
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
413
|
+
options: localVarRequestOptions,
|
|
414
|
+
};
|
|
415
|
+
}),
|
|
372
416
|
};
|
|
373
417
|
};
|
|
374
418
|
exports.OrdersApiAxiosParamCreator = OrdersApiAxiosParamCreator;
|
|
@@ -496,6 +540,24 @@ const OrdersApiFp = function (configuration) {
|
|
|
496
540
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
497
541
|
});
|
|
498
542
|
},
|
|
543
|
+
/**
|
|
544
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
545
|
+
* @summary Retry
|
|
546
|
+
* @param {string} project What project it is
|
|
547
|
+
* @param {string} orderId Unique identifier of an order
|
|
548
|
+
* @param {string} [fields] Specifies which fields to return, separated by commas
|
|
549
|
+
* @param {*} [options] Override http request option.
|
|
550
|
+
* @throws {RequiredError}
|
|
551
|
+
*/
|
|
552
|
+
retryPlatformPayment(project, orderId, fields, options) {
|
|
553
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
554
|
+
var _a, _b, _c;
|
|
555
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.retryPlatformPayment(project, orderId, fields, options);
|
|
556
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
557
|
+
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;
|
|
558
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
559
|
+
});
|
|
560
|
+
},
|
|
499
561
|
};
|
|
500
562
|
};
|
|
501
563
|
exports.OrdersApiFp = OrdersApiFp;
|
|
@@ -566,6 +628,16 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
566
628
|
getOrders(requestParameters, options) {
|
|
567
629
|
return localVarFp.getOrders(requestParameters.project, requestParameters.fields, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.ids, requestParameters.statuses, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, options).then((request) => request(axios, basePath));
|
|
568
630
|
},
|
|
631
|
+
/**
|
|
632
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
633
|
+
* @summary Retry
|
|
634
|
+
* @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
|
|
635
|
+
* @param {*} [options] Override http request option.
|
|
636
|
+
* @throws {RequiredError}
|
|
637
|
+
*/
|
|
638
|
+
retryPlatformPayment(requestParameters, options) {
|
|
639
|
+
return localVarFp.retryPlatformPayment(requestParameters.project, requestParameters.orderId, requestParameters.fields, options).then((request) => request(axios, basePath));
|
|
640
|
+
},
|
|
569
641
|
};
|
|
570
642
|
};
|
|
571
643
|
exports.OrdersApiFactory = OrdersApiFactory;
|
|
@@ -642,6 +714,17 @@ class OrdersApi extends base_1.BaseAPI {
|
|
|
642
714
|
getOrders(requestParameters, options) {
|
|
643
715
|
return (0, exports.OrdersApiFp)(this.configuration).getOrders(requestParameters.project, requestParameters.fields, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.ids, requestParameters.statuses, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, options).then((request) => request(this.axios, this.basePath));
|
|
644
716
|
}
|
|
717
|
+
/**
|
|
718
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
719
|
+
* @summary Retry
|
|
720
|
+
* @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
|
|
721
|
+
* @param {*} [options] Override http request option.
|
|
722
|
+
* @throws {RequiredError}
|
|
723
|
+
* @memberof OrdersApi
|
|
724
|
+
*/
|
|
725
|
+
retryPlatformPayment(requestParameters, options) {
|
|
726
|
+
return (0, exports.OrdersApiFp)(this.configuration).retryPlatformPayment(requestParameters.project, requestParameters.orderId, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
|
|
727
|
+
}
|
|
645
728
|
}
|
|
646
729
|
exports.OrdersApi = OrdersApi;
|
|
647
730
|
/**
|
package/dist/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Orders API
|
|
3
3
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.16.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/base.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Orders API
|
|
6
6
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.16.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Orders API
|
|
3
3
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.16.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|