@teemill/orders 1.28.4 → 1.29.2

package/.openapi-generator/VERSION

@@ -1 +1 @@
-7.20.0
+7.21.0

package/README.md

@@ -1,4 +1,4 @@
-## @teemill/orders@1.28.4
+## @teemill/orders@1.29.2
 
 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:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @teemill/orders@1.28.4 --save
+npm install @teemill/orders@1.29.2 --save
 ```
 
 _unPublished (not recommended):_
@@ -62,7 +62,7 @@ Class | Method | HTTP request | Description
 *OrdersApi* | [**importOrders**](docs/OrdersApi.md#importorders) | **POST** /v1/orders/imports | Import orders
 *OrdersApi* | [**listOrderImportGroups**](docs/OrdersApi.md#listorderimportgroups) | **GET** /v1/orders/imports/{importId}/groups | List order import groups
 *OrdersApi* | [**listOrderImports**](docs/OrdersApi.md#listorderimports) | **GET** /v1/orders/imports | List order imports
-*OrdersApi* | [**retryPlatformPayment**](docs/OrdersApi.md#retryplatformpayment) | **POST** /v1/orders/{orderId}/retryPlatformPayment | Retry
+*OrdersApi* | [**retryPlatformPayment**](docs/OrdersApi.md#retryplatformpayment) | **POST** /v1/orders/{orderId}/retryPlatformPayment | Retry platform payment
 
 
 ### Documentation For Models

package/api.ts

@@ -4,7 +4,7 @@
  * Orders
  * 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.28.4
+ * The version of the OpenAPI document: 1.29.2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -118,7 +118,7 @@ export const ConfirmOrderValidationErrorCodeEnum = {
     BadRequest: 'BAD_REQUEST',
     PaymentFailed: 'PAYMENT_FAILED',
     Conflict: 'CONFLICT',
-    ActionRequired: 'ACTION_REQUIRED'
+    ActionRequired: 'ACTION_REQUIRED',
 } as const;
 
 export type ConfirmOrderValidationErrorCodeEnum = typeof ConfirmOrderValidationErrorCodeEnum[keyof typeof ConfirmOrderValidationErrorCodeEnum];
@@ -154,12 +154,15 @@ export interface ContactInformation1 {
  */
 export interface Coupon {
     /**
-     * Unique object identifier
+     * The unique identifier of the coupon.
      */
     'id': string;
+    /**
+     * The discount code entered by the customer.
+     */
     'code': string;
     /**
-     * Reference to the discount. **Note:** Requires the discounts integration to see the reference.
+     * A URI reference to the discount resource. Requires the discounts integration.
      */
     'ref'?: string | null;
 }
@@ -223,7 +226,7 @@ export interface CustomsInformation {
 }
 
 export const CustomsInformationPreRegistrationTypeEnum = {
-    Ioss: 'IOSS'
+    Ioss: 'IOSS',
 } as const;
 
 export type CustomsInformationPreRegistrationTypeEnum = typeof CustomsInformationPreRegistrationTypeEnum[keyof typeof CustomsInformationPreRegistrationTypeEnum];
@@ -333,8 +336,28 @@ export interface Fulfillment {
      * Reference to the source platform of this fulfillment.
      */
     'platformRef'?: string;
+    /**
+     * Whether the fulfillment is frozen. This will prevent the fulfillment from being picked.
+     */
+    'frozen'?: boolean;
+    /**
+     * List of reason codes why this fulfillment is frozen. - `moderation` - Held for content moderation review. - `internal_screen_print` - Awaiting internal screen print processing. - `manual` - Manually frozen by a user. - `credit_control` - Client is under credit control. - `billing_failed` - Payment for this order failed. - `pickface_flagged` - Flagged on the pickface for review. - `flow_frozen` - Frozen by internal production flow handling. - `fraud` - Frozen due to fraud checks. 
+     */
+    'frozenReasons'?: Array<FulfillmentFrozenReasonsEnum>;
 }
 
+export const FulfillmentFrozenReasonsEnum = {
+    Moderation: 'moderation',
+    InternalScreenPrint: 'internal_screen_print',
+    Manual: 'manual',
+    CreditControl: 'credit_control',
+    BillingFailed: 'billing_failed',
+    PickfaceFlagged: 'pickface_flagged',
+    FlowFrozen: 'flow_frozen',
+    Fraud: 'fraud',
+} as const;
+
+export type FulfillmentFrozenReasonsEnum = typeof FulfillmentFrozenReasonsEnum[keyof typeof FulfillmentFrozenReasonsEnum];
 
 export interface FulfillmentItem {
     /**
@@ -373,7 +396,7 @@ export interface Image {
 }
 export interface ImportOrders202Response {
     /**
-     * Unique object identifier
+     * Unique identifier of the created import. Use this with the GET /v1/orders/imports/{importId} endpoint to track progress.
      */
     'importId'?: string;
 }
@@ -392,11 +415,11 @@ export interface Option {
  */
 export interface Order {
     /**
-     * Unique object identifier
+     * The unique identifier of the order.
      */
     'id'?: string;
     /**
-     * A reference to the resource location
+     * A URI reference to this order resource.
      */
     'ref'?: string;
     /**
@@ -470,23 +493,41 @@ export interface Order {
 }
 
 
+/**
+ * Represents a bulk order import job, tracking the progress and outcome of importing orders from a CSV file.
+ */
 export interface OrderImport {
     /**
-     * Unique object identifier
+     * The unique identifier of this import job.
      */
     'importId': string;
+    /**
+     * The current lifecycle status of this import.
+     */
     'status': OrderImportStatus;
     'counts': OrderImportCounts;
     /**
-     * ISO 8601 Timestamp
+     * The timestamp when the import was created.
      */
     'createdAt': string;
+    /**
+     * The timestamp when the import was cancelled. Null if the import has not been cancelled.
+     */
     'cancelledAt'?: string | null;
+    /**
+     * The timestamp when the import started processing. Null if processing has not yet begun.
+     */
     'startedAt'?: string | null;
+    /**
+     * The timestamp when the import finished processing. Null if processing has not yet completed.
+     */
     'finishedAt'?: string | null;
 }
 
 
+/**
+ * Counts of import groups in each processing state.
+ */
 export interface OrderImportCounts {
     'total': number;
     'pending': number;
@@ -496,7 +537,13 @@ export interface OrderImportCounts {
     'cancelled': number;
     'completed': number;
 }
+/**
+ * An error encountered while processing an import group, including a machine-readable code and human-readable message.
+ */
 export interface OrderImportError {
+    /**
+     * A machine-readable error code identifying the type of import failure.
+     */
     'code': OrderImportErrorCode;
     /**
      * A human-readable description of the error.
@@ -530,17 +577,23 @@ export const OrderImportErrorCode = {
     MissingSku: 'MISSING_SKU',
     ShippingMethodUnavailable: 'SHIPPING_METHOD_UNAVAILABLE',
     TransientSystemError: 'TRANSIENT_SYSTEM_ERROR',
-    ImportFailed: 'IMPORT_FAILED'
+    ImportFailed: 'IMPORT_FAILED',
 } as const;
 
 export type OrderImportErrorCode = typeof OrderImportErrorCode[keyof typeof OrderImportErrorCode];
 
 
+/**
+ * A single group (order) within a bulk import, representing one merchant reference and its processing outcome.
+ */
 export interface OrderImportGroup {
     /**
-     * Unique object identifier
+     * Unique identifier for this import group.
      */
     'id': string;
+    /**
+     * The current lifecycle status of this import group.
+     */
     'status': OrderImportGroupStatus;
     /**
      * The merchant reference from the CSV rows belonging to this group.
@@ -566,8 +619,17 @@ export interface OrderImportGroup {
      * Errors encountered while processing this group. Empty when the group succeeded.
      */
     'errors': Array<OrderImportError>;
+    /**
+     * The timestamp when this group was created. Null if not yet set.
+     */
     'createdAt'?: string | null;
+    /**
+     * The timestamp when this group started processing. Null if processing has not yet begun.
+     */
     'startedAt'?: string | null;
+    /**
+     * The timestamp when this group finished processing. Null if processing has not yet completed.
+     */
     'finishedAt'?: string | null;
 }
 
@@ -581,7 +643,7 @@ export const OrderImportGroupStatus = {
     Processing: 'processing',
     Success: 'success',
     Failed: 'failed',
-    Cancelled: 'cancelled'
+    Cancelled: 'cancelled',
 } as const;
 
 export type OrderImportGroupStatus = typeof OrderImportGroupStatus[keyof typeof OrderImportGroupStatus];
@@ -601,7 +663,7 @@ export const OrderImportStatus = {
     CompletedSuccess: 'completedSuccess',
     CompletedPartial: 'completedPartial',
     CompletedFailed: 'completedFailed',
-    Cancelled: 'cancelled'
+    Cancelled: 'cancelled',
 } as const;
 
 export type OrderImportStatus = typeof OrderImportStatus[keyof typeof OrderImportStatus];
@@ -620,11 +682,11 @@ export interface OrderItem {
      */
     'id'?: string;
     /**
-     * A reference to the variant being ordered
+     * A reference to the product variant being ordered.
      */
     'variantRef': string;
     /**
-     * Options associated to an order item\'s variant, such as color and size.
+     * The variant attributes (e.g. Colour, Size) for this line item.
      */
     'options'?: Array<Option>;
     /**
@@ -732,7 +794,7 @@ export interface PaymentAttempt {
 export const PaymentAttemptPaymentProviderEnum = {
     Stripe: 'stripe',
     Paypal: 'paypal',
-    Wallet: 'wallet'
+    Wallet: 'wallet',
 } as const;
 
 export type PaymentAttemptPaymentProviderEnum = typeof PaymentAttemptPaymentProviderEnum[keyof typeof PaymentAttemptPaymentProviderEnum];
@@ -740,7 +802,7 @@ export const PaymentAttemptStatusEnum = {
     Success: 'success',
     Failed: 'failed',
     Pending: 'pending',
-    Cancelled: 'cancelled'
+    Cancelled: 'cancelled',
 } as const;
 
 export type PaymentAttemptStatusEnum = typeof PaymentAttemptStatusEnum[keyof typeof PaymentAttemptStatusEnum];
@@ -762,6 +824,9 @@ export interface Price {
  * The item cannot be fulfilled at all — either it is out of stock entirely, or the assigned fulfiller cannot produce it (e.g. missing machinery or variant not configured).
  */
 export interface ProductUnavailableError {
+    /**
+     * The error code identifying this as a product unavailable error.
+     */
     'code': ProductUnavailableErrorCodeEnum;
     /**
      * Human-readable description including the product name.
@@ -772,11 +837,11 @@ export interface ProductUnavailableError {
      */
     'productTitle': string;
     /**
-     * Unique object identifier
+     * The unique identifier of the unavailable variant.
      */
     'variantId': string;
     /**
-     * A reference to the variant being ordered
+     * A URI reference to the unavailable variant.
      */
     'variantRef': string;
     /**
@@ -794,12 +859,12 @@ export interface ProductUnavailableError {
 }
 
 export const ProductUnavailableErrorCodeEnum = {
-    ProductUnavailable: 'PRODUCT_UNAVAILABLE'
+    ProductUnavailable: 'PRODUCT_UNAVAILABLE',
 } as const;
 
 export type ProductUnavailableErrorCodeEnum = typeof ProductUnavailableErrorCodeEnum[keyof typeof ProductUnavailableErrorCodeEnum];
 export const ProductUnavailableErrorAvailableQuantityEnum = {
-    NUMBER_0: 0
+    NUMBER_0: 0,
 } as const;
 
 export type ProductUnavailableErrorAvailableQuantityEnum = typeof ProductUnavailableErrorAvailableQuantityEnum[keyof typeof ProductUnavailableErrorAvailableQuantityEnum];
@@ -871,7 +936,7 @@ export const Status = {
     Complete: 'complete',
     Refunded: 'refunded',
     Quote: 'quote',
-    Moderation: 'moderation'
+    Moderation: 'moderation',
 } as const;
 
 export type Status = typeof Status[keyof typeof Status];
@@ -888,6 +953,7 @@ export interface StatusHistoryItem {
 
 /**
  * @type StockConflictError
+ * An error indicating that one or more items in the order cannot be fulfilled due to stock or product availability issues. Use the \'code\' field to determine the specific error type.
  */
 export type StockConflictError = { code: 'PRODUCT_UNAVAILABLE' } & ProductUnavailableError | { code: 'STOCK_UNAVAILABLE' } & StockUnavailableError;
 
@@ -895,6 +961,9 @@ export type StockConflictError = { code: 'PRODUCT_UNAVAILABLE' } & ProductUnavai
  * The requested quantity exceeds available stock. The item can still be ordered in a smaller quantity.
  */
 export interface StockUnavailableError {
+    /**
+     * The error code identifying this as a stock unavailable error.
+     */
     'code': StockUnavailableErrorCodeEnum;
     /**
      * Human-readable description including the product name and available quantity.
@@ -905,11 +974,11 @@ export interface StockUnavailableError {
      */
     'productTitle': string;
     /**
-     * Unique object identifier
+     * The unique identifier of the variant with insufficient stock.
      */
     'variantId': string;
     /**
-     * A reference to the variant being ordered
+     * A URI reference to the variant with insufficient stock.
      */
     'variantRef': string;
     /**
@@ -927,7 +996,7 @@ export interface StockUnavailableError {
 }
 
 export const StockUnavailableErrorCodeEnum = {
-    StockUnavailable: 'STOCK_UNAVAILABLE'
+    StockUnavailable: 'STOCK_UNAVAILABLE',
 } as const;
 
 export type StockUnavailableErrorCodeEnum = typeof StockUnavailableErrorCodeEnum[keyof typeof StockUnavailableErrorCodeEnum];
@@ -1583,7 +1652,7 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
         },
         /**
          * Retries failed platform payment, so fulfillment can proceed.
-         * @summary Retry
+         * @summary Retry platform payment
          * @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
@@ -1818,7 +1887,7 @@ export const OrdersApiFp = function(configuration?: Configuration) {
         },
         /**
          * Retries failed platform payment, so fulfillment can proceed.
-         * @summary Retry
+         * @summary Retry platform payment
          * @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
@@ -1952,7 +2021,7 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
         },
         /**
          * Retries failed platform payment, so fulfillment can proceed.
-         * @summary Retry
+         * @summary Retry platform payment
          * @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -2370,7 +2439,7 @@ export class OrdersApi extends BaseAPI {
 
     /**
      * Retries failed platform payment, so fulfillment can proceed.
-     * @summary Retry
+     * @summary Retry platform payment
      * @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -2387,7 +2456,7 @@ export const ExportOrdersDateFilterTypeEnum = {
     StatusChangedAt: 'statusChangedAt',
     CompletedAt: 'completedAt',
     RefundedAt: 'refundedAt',
-    QuoteAt: 'quoteAt'
+    QuoteAt: 'quoteAt',
 } as const;
 export type ExportOrdersDateFilterTypeEnum = typeof ExportOrdersDateFilterTypeEnum[keyof typeof ExportOrdersDateFilterTypeEnum];
 export const GetOrdersDateFilterTypeEnum = {
@@ -2397,7 +2466,7 @@ export const GetOrdersDateFilterTypeEnum = {
     StatusChangedAt: 'statusChangedAt',
     CompletedAt: 'completedAt',
     RefundedAt: 'refundedAt',
-    QuoteAt: 'quoteAt'
+    QuoteAt: 'quoteAt',
 } as const;
 export type GetOrdersDateFilterTypeEnum = typeof GetOrdersDateFilterTypeEnum[keyof typeof GetOrdersDateFilterTypeEnum];
 

package/base.ts

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

package/common.ts

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

package/configuration.ts

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