@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/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.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).
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.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).
package/dist/common.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).
@@ -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).
@@ -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).
package/dist/esm/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/esm/api.js 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).
@@ -35,6 +35,17 @@ export const ConfirmOrderValidationErrorCodeEnum = {
35
35
  export const CustomsInformationPreRegistrationTypeEnum = {
36
36
  Ioss: 'IOSS'
37
37
  };
38
+ export const PaymentAttemptPaymentProviderEnum = {
39
+ Stripe: 'stripe',
40
+ Paypal: 'paypal',
41
+ Wallet: 'wallet'
42
+ };
43
+ export const PaymentAttemptStatusEnum = {
44
+ Success: 'success',
45
+ Failed: 'failed',
46
+ Pending: 'pending',
47
+ Cancelled: 'cancelled'
48
+ };
38
49
  /**
39
50
  *
40
51
  * @export
@@ -366,6 +377,50 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
366
377
  options: localVarRequestOptions,
367
378
  };
368
379
  }),
380
+ /**
381
+ * Retries failed platform payment, so fulfillment can proceed.
382
+ * @summary Retry
383
+ * @param {string} project What project it is
384
+ * @param {string} orderId Unique identifier of an order
385
+ * @param {string} [fields] Specifies which fields to return, separated by commas
386
+ * @param {*} [options] Override http request option.
387
+ * @throws {RequiredError}
388
+ */
389
+ 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 = {}) {
390
+ // verify required parameter 'project' is not null or undefined
391
+ assertParamExists('retryPlatformPayment', 'project', project);
392
+ // verify required parameter 'orderId' is not null or undefined
393
+ assertParamExists('retryPlatformPayment', 'orderId', orderId);
394
+ const localVarPath = `/v1/orders/{orderId}/retryPlatformPayment`
395
+ .replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
396
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
397
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
398
+ let baseOptions;
399
+ if (configuration) {
400
+ baseOptions = configuration.baseOptions;
401
+ }
402
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
403
+ const localVarHeaderParameter = {};
404
+ const localVarQueryParameter = {};
405
+ // authentication session-oauth required
406
+ // oauth required
407
+ yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
408
+ // authentication api-key required
409
+ yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
410
+ if (project !== undefined) {
411
+ localVarQueryParameter['project'] = project;
412
+ }
413
+ if (fields !== undefined) {
414
+ localVarQueryParameter['fields'] = fields;
415
+ }
416
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
417
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
418
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
419
+ return {
420
+ url: toPathString(localVarUrlObj),
421
+ options: localVarRequestOptions,
422
+ };
423
+ }),
369
424
  };
370
425
  };
371
426
  /**
@@ -492,6 +547,24 @@ export const OrdersApiFp = function (configuration) {
492
547
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
493
548
  });
494
549
  },
550
+ /**
551
+ * Retries failed platform payment, so fulfillment can proceed.
552
+ * @summary Retry
553
+ * @param {string} project What project it is
554
+ * @param {string} orderId Unique identifier of an order
555
+ * @param {string} [fields] Specifies which fields to return, separated by commas
556
+ * @param {*} [options] Override http request option.
557
+ * @throws {RequiredError}
558
+ */
559
+ retryPlatformPayment(project, orderId, fields, options) {
560
+ return __awaiter(this, void 0, void 0, function* () {
561
+ var _a, _b, _c;
562
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.retryPlatformPayment(project, orderId, fields, options);
563
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
564
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrdersApi.retryPlatformPayment']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
565
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
566
+ });
567
+ },
495
568
  };
496
569
  };
497
570
  /**
@@ -561,6 +634,16 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
561
634
  getOrders(requestParameters, options) {
562
635
  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));
563
636
  },
637
+ /**
638
+ * Retries failed platform payment, so fulfillment can proceed.
639
+ * @summary Retry
640
+ * @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
641
+ * @param {*} [options] Override http request option.
642
+ * @throws {RequiredError}
643
+ */
644
+ retryPlatformPayment(requestParameters, options) {
645
+ return localVarFp.retryPlatformPayment(requestParameters.project, requestParameters.orderId, requestParameters.fields, options).then((request) => request(axios, basePath));
646
+ },
564
647
  };
565
648
  };
566
649
  /**
@@ -636,6 +719,17 @@ export class OrdersApi extends BaseAPI {
636
719
  getOrders(requestParameters, options) {
637
720
  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));
638
721
  }
722
+ /**
723
+ * Retries failed platform payment, so fulfillment can proceed.
724
+ * @summary Retry
725
+ * @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
726
+ * @param {*} [options] Override http request option.
727
+ * @throws {RequiredError}
728
+ * @memberof OrdersApi
729
+ */
730
+ retryPlatformPayment(requestParameters, options) {
731
+ return OrdersApiFp(this.configuration).retryPlatformPayment(requestParameters.project, requestParameters.orderId, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
732
+ }
639
733
  }
640
734
  /**
641
735
  * @export
@@ -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).
package/dist/esm/base.js 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).
@@ -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).
@@ -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).
@@ -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).
@@ -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).
@@ -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).
package/dist/esm/index.js 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/index.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).
package/dist/index.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).
@@ -0,0 +1,35 @@
1
+ # Address
2
+
3
+ A person\'s address.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **contactName** | **string** | | [optional] [default to undefined]
10
+ **company** | **string** | | [optional] [default to undefined]
11
+ **line1** | **string** | First line of the address. | [optional] [default to undefined]
12
+ **line2** | **string** | Second line of the address. | [optional] [default to undefined]
13
+ **city** | **string** | City of the address. | [optional] [default to undefined]
14
+ **postalCode** | **string** | Postal code of the address. | [optional] [default to undefined]
15
+ **country** | **string** | Country of the address (ISO 3166-1 alpha-2). | [default to undefined]
16
+ **state** | **string** | State of the address. If the country is Canada, Australia, or the United States, this field is required. | [optional] [default to undefined]
17
+
18
+ ## Example
19
+
20
+ ```typescript
21
+ import { Address } from '@teemill/orders';
22
+
23
+ const instance: Address = {
24
+ contactName,
25
+ company,
26
+ line1,
27
+ line2,
28
+ city,
29
+ postalCode,
30
+ country,
31
+ state,
32
+ };
33
+ ```
34
+
35
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,22 @@
1
+ # ApiError
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **code** | **string** | | [optional] [default to undefined]
9
+ **message** | **string** | | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { ApiError } from '@teemill/orders';
15
+
16
+ const instance: ApiError = {
17
+ code,
18
+ message,
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)
@@ -0,0 +1,24 @@
1
+ # ConfirmOrderFulfillment
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **fulfillmentId** | **string** | Unique object identifier | [default to undefined]
9
+ **shippingMethodId** | **string** | Unique object identifier | [optional] [default to undefined]
10
+ **shipment** | [**ConfirmOrderFulfillmentShipment**](ConfirmOrderFulfillmentShipment.md) | | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { ConfirmOrderFulfillment } from '@teemill/orders';
16
+
17
+ const instance: ConfirmOrderFulfillment = {
18
+ fulfillmentId,
19
+ shippingMethodId,
20
+ shipment,
21
+ };
22
+ ```
23
+
24
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,21 @@
1
+ # ConfirmOrderFulfillmentShipment
2
+
3
+ This field is only required if you are using your own shipping label.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **image** | **string** | Only required if you are generating shipping labels outside of PodOS | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { ConfirmOrderFulfillmentShipment } from '@teemill/orders';
15
+
16
+ const instance: ConfirmOrderFulfillmentShipment = {
17
+ image,
18
+ };
19
+ ```
20
+
21
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,20 @@
1
+ # ConfirmOrderRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **fulfillments** | [**Array&lt;ConfirmOrderFulfillment&gt;**](ConfirmOrderFulfillment.md) | | [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { ConfirmOrderRequest } from '@teemill/orders';
14
+
15
+ const instance: ConfirmOrderRequest = {
16
+ fulfillments,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,22 @@
1
+ # ConfirmOrderValidationError
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **code** | **string** | | [default to undefined]
9
+ **message** | **string** | | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { ConfirmOrderValidationError } from '@teemill/orders';
15
+
16
+ const instance: ConfirmOrderValidationError = {
17
+ code,
18
+ message,
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)
@@ -0,0 +1,23 @@
1
+ # ContactInformation
2
+
3
+ Order recipient contact information, used only for courier tracking/updates.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **email** | **string** | | [default to undefined]
10
+ **phone** | **string** | | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { ContactInformation } from '@teemill/orders';
16
+
17
+ const instance: ContactInformation = {
18
+ email,
19
+ phone,
20
+ };
21
+ ```
22
+
23
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)