@teemill/orders 1.24.1 → 1.25.0

package/dist/api.js

@@ -5,7 +5,7 @@
  * Orders API
  * 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.
  *
- * The version of the OpenAPI document: 1.24.1
+ * The version of the OpenAPI document: 1.25.0
  *
  *
  * 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
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GetOrdersDateFilterTypeEnum = exports.OrdersApi = exports.OrdersApiFactory = exports.OrdersApiFp = exports.OrdersApiAxiosParamCreator = exports.Status = exports.PaymentAttemptStatusEnum = exports.PaymentAttemptPaymentProviderEnum = exports.CustomsInformationPreRegistrationTypeEnum = exports.ConfirmOrderValidationErrorCodeEnum = void 0;
+exports.GetOrdersDateFilterTypeEnum = exports.OrdersApi = exports.OrdersApiFactory = exports.OrdersApiFp = exports.OrdersApiAxiosParamCreator = exports.StockUnavailableErrorCodeEnum = exports.Status = exports.ProductUnavailableErrorAvailableQuantityEnum = exports.ProductUnavailableErrorCodeEnum = exports.PaymentAttemptStatusEnum = exports.PaymentAttemptPaymentProviderEnum = exports.CustomsInformationPreRegistrationTypeEnum = exports.ConfirmOrderValidationErrorCodeEnum = void 0;
 const axios_1 = require("axios");
 // Some imports not used depending on template conditions
 // @ts-ignore
@@ -49,6 +49,15 @@ exports.PaymentAttemptStatusEnum = {
     Pending: 'pending',
     Cancelled: 'cancelled'
 };
+exports.ProductUnavailableErrorCodeEnum = {
+    ProductUnavailable: 'PRODUCT_UNAVAILABLE'
+};
+exports.ProductUnavailableErrorAvailableQuantityEnum = {
+    NUMBER_0: 0
+};
+/**
+ * The lifecycle status of an order or fulfillment: - `new` — Order has been created but not yet confirmed or paid - `paid` — Payment has been received, awaiting fulfillment - `processing` — Order is being produced or packed - `complete` — Order has been shipped - `refunded` — Order has been refunded - `quote` — Order is a draft quote, not yet submitted - `moderation` — Order is held for review
+ */
 exports.Status = {
     New: 'new',
     Paid: 'paid',
@@ -58,6 +67,9 @@ exports.Status = {
     Quote: 'quote',
     Moderation: 'moderation'
 };
+exports.StockUnavailableErrorCodeEnum = {
+    StockUnavailable: 'STOCK_UNAVAILABLE'
+};
 /**
  * OrdersApi - axios parameter creator
  */
@@ -66,7 +78,7 @@ const OrdersApiAxiosParamCreator = function (configuration) {
         /**
          * Cancels an order if it has not yet started processing.
          * @summary Cancel order
-         * @param {string} project What project it is
+         * @param {string} project The project identifier to scope the request to.
          * @param {string} orderId Unique identifier of an order
          * @param {string} [fields] Specifies which fields to return, separated by commas
          * @param {*} [options] Override http request option.
@@ -111,9 +123,9 @@ const OrdersApiAxiosParamCreator = function (configuration) {
         /**
          * Confirms an order, and submits it as ready to take payment and begin processing.
          * @summary Confirm order
-         * @param {string} project What project it is
+         * @param {string} project The project identifier to scope the request to.
          * @param {string} orderId Unique identifier of an order
-         * @param {ConfirmOrderRequest} confirmOrderRequest ConfirmFulfillment schema
+         * @param {ConfirmOrderRequest} confirmOrderRequest Confirm an order by specifying shipping methods for each fulfillment. This submits the order for payment processing and production. Orders should be confirmed promptly after creation — the longer an order remains unconfirmed, the greater the chance that stock availability changes. If stock is no longer available at the time of confirmation, the request will fail and you will need to create a new order.
          * @param {string} [fields] Specifies which fields to return, separated by commas
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -161,7 +173,7 @@ const OrdersApiAxiosParamCreator = function (configuration) {
         /**
          * Creates a new order for the provided variants. You can fetch details and references to the given project\'s variants from the Product Catalog API.
          * @summary Create order
-         * @param {string} project What project it is
+         * @param {string} project The project identifier to scope the request to.
          * @param {CreateOrder} createOrder Create Order schema
          * @param {string} [fields] Specifies which fields to return, separated by commas
          * @param {*} [options] Override http request option.
@@ -207,7 +219,7 @@ const OrdersApiAxiosParamCreator = function (configuration) {
         /**
          * Download an order invoice.
          * @summary Download order invoice
-         * @param {string} project What project it is
+         * @param {string} project The project identifier to scope the request to.
          * @param {string} orderId Unique identifier of an order
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -248,9 +260,9 @@ const OrdersApiAxiosParamCreator = function (configuration) {
         /**
          * Export orders as a CSV file
          * @summary Export orders
-         * @param {string} project What project it is
-         * @param {string} start Start of date range to filter by when orders were placed
-         * @param {string} [end] End of date range
+         * @param {string} project The project identifier to scope the request to.
+         * @param {string} start Start of the date range to filter by when orders were placed.
+         * @param {string} [end] End of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
          * @param {string} [search] Search term to filter based on order reference, customer name and email
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -303,7 +315,7 @@ const OrdersApiAxiosParamCreator = function (configuration) {
         /**
          * Get an order by a given ID.
          * @summary Get order
-         * @param {string} project What project it is
+         * @param {string} project The project identifier to scope the request to.
          * @param {string} orderId Unique identifier of an order
          * @param {string} [fields] Specifies which fields to return, separated by commas
          * @param {*} [options] Override http request option.
@@ -348,15 +360,15 @@ const OrdersApiAxiosParamCreator = function (configuration) {
         /**
          * Lists all orders placed on this project, paginated into configurable chunks.
          * @summary List orders
-         * @param {string} project What project it is
+         * @param {string} project The project identifier to scope the request to.
          * @param {string} [fields] Specifies which fields to return, separated by commas
          * @param {number} [pageToken] Page reference token
          * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
          * @param {string} [search] Search term to filter based on order reference, customer name and email
-         * @param {Array<string>} [ids] Specify fulfillment IDs to list
-         * @param {Array<Status>} [statuses] Filter by fulfillment status
-         * @param {string} [start] Start of date range
-         * @param {string} [end] End of date range
+         * @param {Array<string>} [ids] Filter to specific order IDs. Only orders matching these IDs will be returned.
+         * @param {Array<Status>} [statuses] Filter by order status. Only orders matching one of the given statuses will be returned.
+         * @param {string} [start] Start of date range filter. Which date field this applies to is controlled by the &#x60;dateFilterType&#x60; parameter.
+         * @param {string} [end] End of date range filter. Which date field this applies to is controlled by the &#x60;dateFilterType&#x60; parameter.
          * @param {GetOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the &#x60;start&#x60; and &#x60;end&#x60; fields should query.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -425,7 +437,7 @@ const OrdersApiAxiosParamCreator = function (configuration) {
         /**
          * Retries failed platform payment, so fulfillment can proceed.
          * @summary Retry
-         * @param {string} project What project it is
+         * @param {string} project The project identifier to scope the request to.
          * @param {string} orderId Unique identifier of an order
          * @param {string} [fields] Specifies which fields to return, separated by commas
          * @param {*} [options] Override http request option.
@@ -479,7 +491,7 @@ const OrdersApiFp = function (configuration) {
         /**
          * Cancels an order if it has not yet started processing.
          * @summary Cancel order
-         * @param {string} project What project it is
+         * @param {string} project The project identifier to scope the request to.
          * @param {string} orderId Unique identifier of an order
          * @param {string} [fields] Specifies which fields to return, separated by commas
          * @param {*} [options] Override http request option.
@@ -497,9 +509,9 @@ const OrdersApiFp = function (configuration) {
         /**
          * Confirms an order, and submits it as ready to take payment and begin processing.
          * @summary Confirm order
-         * @param {string} project What project it is
+         * @param {string} project The project identifier to scope the request to.
          * @param {string} orderId Unique identifier of an order
-         * @param {ConfirmOrderRequest} confirmOrderRequest ConfirmFulfillment schema
+         * @param {ConfirmOrderRequest} confirmOrderRequest Confirm an order by specifying shipping methods for each fulfillment. This submits the order for payment processing and production. Orders should be confirmed promptly after creation — the longer an order remains unconfirmed, the greater the chance that stock availability changes. If stock is no longer available at the time of confirmation, the request will fail and you will need to create a new order.
          * @param {string} [fields] Specifies which fields to return, separated by commas
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -516,7 +528,7 @@ const OrdersApiFp = function (configuration) {
         /**
          * Creates a new order for the provided variants. You can fetch details and references to the given project\'s variants from the Product Catalog API.
          * @summary Create order
-         * @param {string} project What project it is
+         * @param {string} project The project identifier to scope the request to.
          * @param {CreateOrder} createOrder Create Order schema
          * @param {string} [fields] Specifies which fields to return, separated by commas
          * @param {*} [options] Override http request option.
@@ -534,7 +546,7 @@ const OrdersApiFp = function (configuration) {
         /**
          * Download an order invoice.
          * @summary Download order invoice
-         * @param {string} project What project it is
+         * @param {string} project The project identifier to scope the request to.
          * @param {string} orderId Unique identifier of an order
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -551,9 +563,9 @@ const OrdersApiFp = function (configuration) {
         /**
          * Export orders as a CSV file
          * @summary Export orders
-         * @param {string} project What project it is
-         * @param {string} start Start of date range to filter by when orders were placed
-         * @param {string} [end] End of date range
+         * @param {string} project The project identifier to scope the request to.
+         * @param {string} start Start of the date range to filter by when orders were placed.
+         * @param {string} [end] End of date range filter. Which date field this applies to is controlled by the &#x60;dateFilterType&#x60; parameter.
          * @param {string} [search] Search term to filter based on order reference, customer name and email
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -570,7 +582,7 @@ const OrdersApiFp = function (configuration) {
         /**
          * Get an order by a given ID.
          * @summary Get order
-         * @param {string} project What project it is
+         * @param {string} project The project identifier to scope the request to.
          * @param {string} orderId Unique identifier of an order
          * @param {string} [fields] Specifies which fields to return, separated by commas
          * @param {*} [options] Override http request option.
@@ -588,15 +600,15 @@ const OrdersApiFp = function (configuration) {
         /**
          * Lists all orders placed on this project, paginated into configurable chunks.
          * @summary List orders
-         * @param {string} project What project it is
+         * @param {string} project The project identifier to scope the request to.
          * @param {string} [fields] Specifies which fields to return, separated by commas
          * @param {number} [pageToken] Page reference token
          * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
          * @param {string} [search] Search term to filter based on order reference, customer name and email
-         * @param {Array<string>} [ids] Specify fulfillment IDs to list
-         * @param {Array<Status>} [statuses] Filter by fulfillment status
-         * @param {string} [start] Start of date range
-         * @param {string} [end] End of date range
+         * @param {Array<string>} [ids] Filter to specific order IDs. Only orders matching these IDs will be returned.
+         * @param {Array<Status>} [statuses] Filter by order status. Only orders matching one of the given statuses will be returned.
+         * @param {string} [start] Start of date range filter. Which date field this applies to is controlled by the &#x60;dateFilterType&#x60; parameter.
+         * @param {string} [end] End of date range filter. Which date field this applies to is controlled by the &#x60;dateFilterType&#x60; parameter.
          * @param {GetOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the &#x60;start&#x60; and &#x60;end&#x60; fields should query.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -613,7 +625,7 @@ const OrdersApiFp = function (configuration) {
         /**
          * Retries failed platform payment, so fulfillment can proceed.
          * @summary Retry
-         * @param {string} project What project it is
+         * @param {string} project The project identifier to scope the request to.
          * @param {string} orderId Unique identifier of an order
          * @param {string} [fields] Specifies which fields to return, separated by commas
          * @param {*} [options] Override http request option.

package/dist/base.d.ts

@@ -2,7 +2,7 @@
  * Orders API
  * 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.
  *
- * The version of the OpenAPI document: 1.24.1
+ * The version of the OpenAPI document: 1.25.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/base.js

@@ -5,7 +5,7 @@
  * Orders API
  * 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.
  *
- * The version of the OpenAPI document: 1.24.1
+ * The version of the OpenAPI document: 1.25.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/common.d.ts

@@ -2,7 +2,7 @@
  * Orders API
  * 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.
  *
- * The version of the OpenAPI document: 1.24.1
+ * The version of the OpenAPI document: 1.25.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/common.js

@@ -5,7 +5,7 @@
  * Orders API
  * 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.
  *
- * The version of the OpenAPI document: 1.24.1
+ * The version of the OpenAPI document: 1.25.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/configuration.d.ts

@@ -2,7 +2,7 @@
  * Orders API
  * 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.
  *
- * The version of the OpenAPI document: 1.24.1
+ * The version of the OpenAPI document: 1.25.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/configuration.js

@@ -4,7 +4,7 @@
  * Orders API
  * 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.
  *
- * The version of the OpenAPI document: 1.24.1
+ * The version of the OpenAPI document: 1.25.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).