@teemill/orders 1.15.3 → 1.17.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.
Files changed (59) hide show
  1. package/README.md +73 -2
  2. package/api.ts +179 -1
  3. package/base.ts +1 -1
  4. package/common.ts +1 -1
  5. package/configuration.ts +1 -1
  6. package/dist/api.d.ts +119 -1
  7. package/dist/api.js +96 -2
  8. package/dist/base.d.ts +1 -1
  9. package/dist/base.js +1 -1
  10. package/dist/common.d.ts +1 -1
  11. package/dist/common.js +1 -1
  12. package/dist/configuration.d.ts +1 -1
  13. package/dist/configuration.js +1 -1
  14. package/dist/esm/api.d.ts +119 -1
  15. package/dist/esm/api.js +95 -1
  16. package/dist/esm/base.d.ts +1 -1
  17. package/dist/esm/base.js +1 -1
  18. package/dist/esm/common.d.ts +1 -1
  19. package/dist/esm/common.js +1 -1
  20. package/dist/esm/configuration.d.ts +1 -1
  21. package/dist/esm/configuration.js +1 -1
  22. package/dist/esm/index.d.ts +1 -1
  23. package/dist/esm/index.js +1 -1
  24. package/dist/index.d.ts +1 -1
  25. package/dist/index.js +1 -1
  26. package/docs/Address.md +35 -0
  27. package/docs/ApiError.md +22 -0
  28. package/docs/ConfirmOrderFulfillment.md +24 -0
  29. package/docs/ConfirmOrderFulfillmentShipment.md +21 -0
  30. package/docs/ConfirmOrderRequest.md +20 -0
  31. package/docs/ConfirmOrderValidationError.md +22 -0
  32. package/docs/ContactInformation.md +23 -0
  33. package/docs/CreateOrder.md +29 -0
  34. package/docs/CreateOrderContactInformation.md +23 -0
  35. package/docs/CustomsInformation.md +27 -0
  36. package/docs/CustomsInformation1.md +26 -0
  37. package/docs/DeliveryEstimates.md +24 -0
  38. package/docs/ExportOrders202Response.md +20 -0
  39. package/docs/Fulfillment.md +34 -0
  40. package/docs/FulfillmentFulfiller.md +23 -0
  41. package/docs/FulfillmentFulfillerLocation.md +22 -0
  42. package/docs/FulfillmentItem.md +24 -0
  43. package/docs/Image.md +27 -0
  44. package/docs/Option.md +22 -0
  45. package/docs/Order.md +58 -0
  46. package/docs/OrderItem.md +40 -0
  47. package/docs/OrderItem1.md +24 -0
  48. package/docs/OrderItem1RecipientCost.md +22 -0
  49. package/docs/OrderTracking.md +24 -0
  50. package/docs/OrdersApi.md +475 -0
  51. package/docs/OrdersResponse.md +22 -0
  52. package/docs/Origin.md +22 -0
  53. package/docs/PaymentAttempt.md +29 -0
  54. package/docs/Price.md +23 -0
  55. package/docs/ShippingMethod.md +34 -0
  56. package/docs/Status.md +18 -0
  57. package/docs/StatusHistoryItem.md +22 -0
  58. package/index.ts +1 -1
  59. package/package.json +1 -1
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @teemill/orders@1.15.3
1
+ ## @teemill/orders@1.17.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.15.3 --save
39
+ npm install @teemill/orders@1.17.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.15.3
7
+ * The version of the OpenAPI document: 1.17.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,60 @@ export interface Origin {
832
838
  */
833
839
  'isPaid'?: boolean;
834
840
  }
841
+ /**
842
+ * List of payment attempts for this order
843
+ * @export
844
+ * @interface PaymentAttempt
845
+ */
846
+ export interface PaymentAttempt {
847
+ /**
848
+ *
849
+ * @type {string}
850
+ * @memberof PaymentAttempt
851
+ */
852
+ 'paymentProvider'?: PaymentAttemptPaymentProviderEnum;
853
+ /**
854
+ *
855
+ * @type {string}
856
+ * @memberof PaymentAttempt
857
+ */
858
+ 'status'?: PaymentAttemptStatusEnum;
859
+ /**
860
+ *
861
+ * @type {string}
862
+ * @memberof PaymentAttempt
863
+ */
864
+ 'transactionId'?: string | null;
865
+ /**
866
+ *
867
+ * @type {string}
868
+ * @memberof PaymentAttempt
869
+ */
870
+ 'message'?: string;
871
+ /**
872
+ * ISO 8601 Timestamp
873
+ * @type {string}
874
+ * @memberof PaymentAttempt
875
+ */
876
+ 'createdAt'?: string;
877
+ }
878
+
879
+ export const PaymentAttemptPaymentProviderEnum = {
880
+ Stripe: 'stripe',
881
+ Paypal: 'paypal',
882
+ Wallet: 'wallet'
883
+ } as const;
884
+
885
+ export type PaymentAttemptPaymentProviderEnum = typeof PaymentAttemptPaymentProviderEnum[keyof typeof PaymentAttemptPaymentProviderEnum];
886
+ export const PaymentAttemptStatusEnum = {
887
+ Success: 'success',
888
+ Failed: 'failed',
889
+ Pending: 'pending',
890
+ Cancelled: 'cancelled'
891
+ } as const;
892
+
893
+ export type PaymentAttemptStatusEnum = typeof PaymentAttemptStatusEnum[keyof typeof PaymentAttemptStatusEnum];
894
+
835
895
  /**
836
896
  * Standard price definition that defines the amount and currency.
837
897
  * @export
@@ -1321,6 +1381,59 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
1321
1381
 
1322
1382
 
1323
1383
 
1384
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1385
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1386
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1387
+
1388
+ return {
1389
+ url: toPathString(localVarUrlObj),
1390
+ options: localVarRequestOptions,
1391
+ };
1392
+ },
1393
+ /**
1394
+ * Retries failed platform payment, so fulfillment can proceed.
1395
+ * @summary Retry
1396
+ * @param {string} project What project it is
1397
+ * @param {string} orderId Unique identifier of an order
1398
+ * @param {string} [fields] Specifies which fields to return, separated by commas
1399
+ * @param {*} [options] Override http request option.
1400
+ * @throws {RequiredError}
1401
+ */
1402
+ retryPlatformPayment: async (project: string, orderId: string, fields?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1403
+ // verify required parameter 'project' is not null or undefined
1404
+ assertParamExists('retryPlatformPayment', 'project', project)
1405
+ // verify required parameter 'orderId' is not null or undefined
1406
+ assertParamExists('retryPlatformPayment', 'orderId', orderId)
1407
+ const localVarPath = `/v1/orders/{orderId}/retryPlatformPayment`
1408
+ .replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
1409
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1410
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1411
+ let baseOptions;
1412
+ if (configuration) {
1413
+ baseOptions = configuration.baseOptions;
1414
+ }
1415
+
1416
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
1417
+ const localVarHeaderParameter = {} as any;
1418
+ const localVarQueryParameter = {} as any;
1419
+
1420
+ // authentication session-oauth required
1421
+ // oauth required
1422
+ await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
1423
+
1424
+ // authentication api-key required
1425
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
1426
+
1427
+ if (project !== undefined) {
1428
+ localVarQueryParameter['project'] = project;
1429
+ }
1430
+
1431
+ if (fields !== undefined) {
1432
+ localVarQueryParameter['fields'] = fields;
1433
+ }
1434
+
1435
+
1436
+
1324
1437
  setSearchParams(localVarUrlObj, localVarQueryParameter);
1325
1438
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1326
1439
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -1439,6 +1552,21 @@ export const OrdersApiFp = function(configuration?: Configuration) {
1439
1552
  const localVarOperationServerBasePath = operationServerMap['OrdersApi.getOrders']?.[localVarOperationServerIndex]?.url;
1440
1553
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1441
1554
  },
1555
+ /**
1556
+ * Retries failed platform payment, so fulfillment can proceed.
1557
+ * @summary Retry
1558
+ * @param {string} project What project it is
1559
+ * @param {string} orderId Unique identifier of an order
1560
+ * @param {string} [fields] Specifies which fields to return, separated by commas
1561
+ * @param {*} [options] Override http request option.
1562
+ * @throws {RequiredError}
1563
+ */
1564
+ async retryPlatformPayment(project: string, orderId: string, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>> {
1565
+ const localVarAxiosArgs = await localVarAxiosParamCreator.retryPlatformPayment(project, orderId, fields, options);
1566
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1567
+ const localVarOperationServerBasePath = operationServerMap['OrdersApi.retryPlatformPayment']?.[localVarOperationServerIndex]?.url;
1568
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1569
+ },
1442
1570
  }
1443
1571
  };
1444
1572
 
@@ -1509,6 +1637,16 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
1509
1637
  getOrders(requestParameters: OrdersApiGetOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrdersResponse> {
1510
1638
  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
1639
  },
1640
+ /**
1641
+ * Retries failed platform payment, so fulfillment can proceed.
1642
+ * @summary Retry
1643
+ * @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
1644
+ * @param {*} [options] Override http request option.
1645
+ * @throws {RequiredError}
1646
+ */
1647
+ retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order> {
1648
+ return localVarFp.retryPlatformPayment(requestParameters.project, requestParameters.orderId, requestParameters.fields, options).then((request) => request(axios, basePath));
1649
+ },
1512
1650
  };
1513
1651
  };
1514
1652
 
@@ -1743,6 +1881,34 @@ export interface OrdersApiGetOrdersRequest {
1743
1881
  readonly dateFilterType?: GetOrdersDateFilterTypeEnum
1744
1882
  }
1745
1883
 
1884
+ /**
1885
+ * Request parameters for retryPlatformPayment operation in OrdersApi.
1886
+ * @export
1887
+ * @interface OrdersApiRetryPlatformPaymentRequest
1888
+ */
1889
+ export interface OrdersApiRetryPlatformPaymentRequest {
1890
+ /**
1891
+ * What project it is
1892
+ * @type {string}
1893
+ * @memberof OrdersApiRetryPlatformPayment
1894
+ */
1895
+ readonly project: string
1896
+
1897
+ /**
1898
+ * Unique identifier of an order
1899
+ * @type {string}
1900
+ * @memberof OrdersApiRetryPlatformPayment
1901
+ */
1902
+ readonly orderId: string
1903
+
1904
+ /**
1905
+ * Specifies which fields to return, separated by commas
1906
+ * @type {string}
1907
+ * @memberof OrdersApiRetryPlatformPayment
1908
+ */
1909
+ readonly fields?: string
1910
+ }
1911
+
1746
1912
  /**
1747
1913
  * OrdersApi - object-oriented interface
1748
1914
  * @export
@@ -1821,6 +1987,18 @@ export class OrdersApi extends BaseAPI {
1821
1987
  public getOrders(requestParameters: OrdersApiGetOrdersRequest, options?: RawAxiosRequestConfig) {
1822
1988
  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
1989
  }
1990
+
1991
+ /**
1992
+ * Retries failed platform payment, so fulfillment can proceed.
1993
+ * @summary Retry
1994
+ * @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
1995
+ * @param {*} [options] Override http request option.
1996
+ * @throws {RequiredError}
1997
+ * @memberof OrdersApi
1998
+ */
1999
+ public retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig) {
2000
+ return OrdersApiFp(this.configuration).retryPlatformPayment(requestParameters.project, requestParameters.orderId, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
2001
+ }
1824
2002
  }
1825
2003
 
1826
2004
  /**
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.15.3
7
+ * The version of the OpenAPI document: 1.17.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.15.3
7
+ * The version of the OpenAPI document: 1.17.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.15.3
7
+ * The version of the OpenAPI document: 1.17.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.15.3
5
+ * The version of the OpenAPI document: 1.17.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,56 @@ export interface Origin {
812
818
  */
813
819
  'isPaid'?: boolean;
814
820
  }
821
+ /**
822
+ * List of payment attempts for this order
823
+ * @export
824
+ * @interface PaymentAttempt
825
+ */
826
+ export interface PaymentAttempt {
827
+ /**
828
+ *
829
+ * @type {string}
830
+ * @memberof PaymentAttempt
831
+ */
832
+ 'paymentProvider'?: PaymentAttemptPaymentProviderEnum;
833
+ /**
834
+ *
835
+ * @type {string}
836
+ * @memberof PaymentAttempt
837
+ */
838
+ 'status'?: PaymentAttemptStatusEnum;
839
+ /**
840
+ *
841
+ * @type {string}
842
+ * @memberof PaymentAttempt
843
+ */
844
+ 'transactionId'?: string | null;
845
+ /**
846
+ *
847
+ * @type {string}
848
+ * @memberof PaymentAttempt
849
+ */
850
+ 'message'?: string;
851
+ /**
852
+ * ISO 8601 Timestamp
853
+ * @type {string}
854
+ * @memberof PaymentAttempt
855
+ */
856
+ 'createdAt'?: string;
857
+ }
858
+ export declare const PaymentAttemptPaymentProviderEnum: {
859
+ readonly Stripe: "stripe";
860
+ readonly Paypal: "paypal";
861
+ readonly Wallet: "wallet";
862
+ };
863
+ export type PaymentAttemptPaymentProviderEnum = typeof PaymentAttemptPaymentProviderEnum[keyof typeof PaymentAttemptPaymentProviderEnum];
864
+ export declare const PaymentAttemptStatusEnum: {
865
+ readonly Success: "success";
866
+ readonly Failed: "failed";
867
+ readonly Pending: "pending";
868
+ readonly Cancelled: "cancelled";
869
+ };
870
+ export type PaymentAttemptStatusEnum = typeof PaymentAttemptStatusEnum[keyof typeof PaymentAttemptStatusEnum];
815
871
  /**
816
872
  * Standard price definition that defines the amount and currency.
817
873
  * @export
@@ -993,6 +1049,16 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
993
1049
  * @throws {RequiredError}
994
1050
  */
995
1051
  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>;
1052
+ /**
1053
+ * Retries failed platform payment, so fulfillment can proceed.
1054
+ * @summary Retry
1055
+ * @param {string} project What project it is
1056
+ * @param {string} orderId Unique identifier of an order
1057
+ * @param {string} [fields] Specifies which fields to return, separated by commas
1058
+ * @param {*} [options] Override http request option.
1059
+ * @throws {RequiredError}
1060
+ */
1061
+ retryPlatformPayment: (project: string, orderId: string, fields?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
996
1062
  };
997
1063
  /**
998
1064
  * OrdersApi - functional programming interface
@@ -1068,6 +1134,16 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
1068
1134
  * @throws {RequiredError}
1069
1135
  */
1070
1136
  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>>;
1137
+ /**
1138
+ * Retries failed platform payment, so fulfillment can proceed.
1139
+ * @summary Retry
1140
+ * @param {string} project What project it is
1141
+ * @param {string} orderId Unique identifier of an order
1142
+ * @param {string} [fields] Specifies which fields to return, separated by commas
1143
+ * @param {*} [options] Override http request option.
1144
+ * @throws {RequiredError}
1145
+ */
1146
+ retryPlatformPayment(project: string, orderId: string, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
1071
1147
  };
1072
1148
  /**
1073
1149
  * OrdersApi - factory interface
@@ -1122,6 +1198,14 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
1122
1198
  * @throws {RequiredError}
1123
1199
  */
1124
1200
  getOrders(requestParameters: OrdersApiGetOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrdersResponse>;
1201
+ /**
1202
+ * Retries failed platform payment, so fulfillment can proceed.
1203
+ * @summary Retry
1204
+ * @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
1205
+ * @param {*} [options] Override http request option.
1206
+ * @throws {RequiredError}
1207
+ */
1208
+ retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order>;
1125
1209
  };
1126
1210
  /**
1127
1211
  * Request parameters for cancelOrder operation in OrdersApi.
@@ -1327,6 +1411,31 @@ export interface OrdersApiGetOrdersRequest {
1327
1411
  */
1328
1412
  readonly dateFilterType?: GetOrdersDateFilterTypeEnum;
1329
1413
  }
1414
+ /**
1415
+ * Request parameters for retryPlatformPayment operation in OrdersApi.
1416
+ * @export
1417
+ * @interface OrdersApiRetryPlatformPaymentRequest
1418
+ */
1419
+ export interface OrdersApiRetryPlatformPaymentRequest {
1420
+ /**
1421
+ * What project it is
1422
+ * @type {string}
1423
+ * @memberof OrdersApiRetryPlatformPayment
1424
+ */
1425
+ readonly project: string;
1426
+ /**
1427
+ * Unique identifier of an order
1428
+ * @type {string}
1429
+ * @memberof OrdersApiRetryPlatformPayment
1430
+ */
1431
+ readonly orderId: string;
1432
+ /**
1433
+ * Specifies which fields to return, separated by commas
1434
+ * @type {string}
1435
+ * @memberof OrdersApiRetryPlatformPayment
1436
+ */
1437
+ readonly fields?: string;
1438
+ }
1330
1439
  /**
1331
1440
  * OrdersApi - object-oriented interface
1332
1441
  * @export
@@ -1388,6 +1497,15 @@ export declare class OrdersApi extends BaseAPI {
1388
1497
  * @memberof OrdersApi
1389
1498
  */
1390
1499
  getOrders(requestParameters: OrdersApiGetOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrdersResponse, any>>;
1500
+ /**
1501
+ * Retries failed platform payment, so fulfillment can proceed.
1502
+ * @summary Retry
1503
+ * @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
1504
+ * @param {*} [options] Override http request option.
1505
+ * @throws {RequiredError}
1506
+ * @memberof OrdersApi
1507
+ */
1508
+ retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
1391
1509
  }
1392
1510
  /**
1393
1511
  * @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.15.3
8
+ * The version of the OpenAPI document: 1.17.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
22
22
  });
23
23
  };
24
24
  Object.defineProperty(exports, "__esModule", { value: true });
25
- exports.GetOrdersDateFilterTypeEnum = exports.OrdersApi = exports.OrdersApiFactory = exports.OrdersApiFp = exports.OrdersApiAxiosParamCreator = exports.Status = exports.CustomsInformationPreRegistrationTypeEnum = exports.ConfirmOrderValidationErrorCodeEnum = void 0;
25
+ exports.GetOrdersDateFilterTypeEnum = exports.OrdersApi = exports.OrdersApiFactory = exports.OrdersApiFp = exports.OrdersApiAxiosParamCreator = exports.Status = exports.PaymentAttemptStatusEnum = exports.PaymentAttemptPaymentProviderEnum = exports.CustomsInformationPreRegistrationTypeEnum = exports.ConfirmOrderValidationErrorCodeEnum = void 0;
26
26
  const axios_1 = require("axios");
27
27
  // Some imports not used depending on template conditions
28
28
  // @ts-ignore
@@ -38,6 +38,17 @@ exports.ConfirmOrderValidationErrorCodeEnum = {
38
38
  exports.CustomsInformationPreRegistrationTypeEnum = {
39
39
  Ioss: 'IOSS'
40
40
  };
41
+ exports.PaymentAttemptPaymentProviderEnum = {
42
+ Stripe: 'stripe',
43
+ Paypal: 'paypal',
44
+ Wallet: 'wallet'
45
+ };
46
+ exports.PaymentAttemptStatusEnum = {
47
+ Success: 'success',
48
+ Failed: 'failed',
49
+ Pending: 'pending',
50
+ Cancelled: 'cancelled'
51
+ };
41
52
  /**
42
53
  *
43
54
  * @export
@@ -369,6 +380,50 @@ const OrdersApiAxiosParamCreator = function (configuration) {
369
380
  options: localVarRequestOptions,
370
381
  };
371
382
  }),
383
+ /**
384
+ * Retries failed platform payment, so fulfillment can proceed.
385
+ * @summary Retry
386
+ * @param {string} project What project it is
387
+ * @param {string} orderId Unique identifier of an order
388
+ * @param {string} [fields] Specifies which fields to return, separated by commas
389
+ * @param {*} [options] Override http request option.
390
+ * @throws {RequiredError}
391
+ */
392
+ 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 = {}) {
393
+ // verify required parameter 'project' is not null or undefined
394
+ (0, common_1.assertParamExists)('retryPlatformPayment', 'project', project);
395
+ // verify required parameter 'orderId' is not null or undefined
396
+ (0, common_1.assertParamExists)('retryPlatformPayment', 'orderId', orderId);
397
+ const localVarPath = `/v1/orders/{orderId}/retryPlatformPayment`
398
+ .replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
399
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
400
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
401
+ let baseOptions;
402
+ if (configuration) {
403
+ baseOptions = configuration.baseOptions;
404
+ }
405
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
406
+ const localVarHeaderParameter = {};
407
+ const localVarQueryParameter = {};
408
+ // authentication session-oauth required
409
+ // oauth required
410
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
411
+ // authentication api-key required
412
+ yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
413
+ if (project !== undefined) {
414
+ localVarQueryParameter['project'] = project;
415
+ }
416
+ if (fields !== undefined) {
417
+ localVarQueryParameter['fields'] = fields;
418
+ }
419
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
420
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
421
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
422
+ return {
423
+ url: (0, common_1.toPathString)(localVarUrlObj),
424
+ options: localVarRequestOptions,
425
+ };
426
+ }),
372
427
  };
373
428
  };
374
429
  exports.OrdersApiAxiosParamCreator = OrdersApiAxiosParamCreator;
@@ -496,6 +551,24 @@ const OrdersApiFp = function (configuration) {
496
551
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
497
552
  });
498
553
  },
554
+ /**
555
+ * Retries failed platform payment, so fulfillment can proceed.
556
+ * @summary Retry
557
+ * @param {string} project What project it is
558
+ * @param {string} orderId Unique identifier of an order
559
+ * @param {string} [fields] Specifies which fields to return, separated by commas
560
+ * @param {*} [options] Override http request option.
561
+ * @throws {RequiredError}
562
+ */
563
+ retryPlatformPayment(project, orderId, fields, options) {
564
+ return __awaiter(this, void 0, void 0, function* () {
565
+ var _a, _b, _c;
566
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.retryPlatformPayment(project, orderId, fields, options);
567
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
568
+ 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;
569
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
570
+ });
571
+ },
499
572
  };
500
573
  };
501
574
  exports.OrdersApiFp = OrdersApiFp;
@@ -566,6 +639,16 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
566
639
  getOrders(requestParameters, options) {
567
640
  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
641
  },
642
+ /**
643
+ * Retries failed platform payment, so fulfillment can proceed.
644
+ * @summary Retry
645
+ * @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
646
+ * @param {*} [options] Override http request option.
647
+ * @throws {RequiredError}
648
+ */
649
+ retryPlatformPayment(requestParameters, options) {
650
+ return localVarFp.retryPlatformPayment(requestParameters.project, requestParameters.orderId, requestParameters.fields, options).then((request) => request(axios, basePath));
651
+ },
569
652
  };
570
653
  };
571
654
  exports.OrdersApiFactory = OrdersApiFactory;
@@ -642,6 +725,17 @@ class OrdersApi extends base_1.BaseAPI {
642
725
  getOrders(requestParameters, options) {
643
726
  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
727
  }
728
+ /**
729
+ * Retries failed platform payment, so fulfillment can proceed.
730
+ * @summary Retry
731
+ * @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
732
+ * @param {*} [options] Override http request option.
733
+ * @throws {RequiredError}
734
+ * @memberof OrdersApi
735
+ */
736
+ retryPlatformPayment(requestParameters, options) {
737
+ return (0, exports.OrdersApiFp)(this.configuration).retryPlatformPayment(requestParameters.project, requestParameters.orderId, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
738
+ }
645
739
  }
646
740
  exports.OrdersApi = OrdersApi;
647
741
  /**
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.15.3
5
+ * The version of the OpenAPI document: 1.17.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).