@teemill/orders 1.28.4 → 1.29.2

package/dist/api.d.ts

@@ -2,7 +2,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).
@@ -140,12 +140,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;
 }
@@ -316,7 +319,26 @@ 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 declare const FulfillmentFrozenReasonsEnum: {
+    readonly Moderation: "moderation";
+    readonly InternalScreenPrint: "internal_screen_print";
+    readonly Manual: "manual";
+    readonly CreditControl: "credit_control";
+    readonly BillingFailed: "billing_failed";
+    readonly PickfaceFlagged: "pickface_flagged";
+    readonly FlowFrozen: "flow_frozen";
+    readonly Fraud: "fraud";
+};
+export type FulfillmentFrozenReasonsEnum = typeof FulfillmentFrozenReasonsEnum[keyof typeof FulfillmentFrozenReasonsEnum];
 export interface FulfillmentItem {
     /**
      * Unique identifier for this fulfillment item.
@@ -354,7 +376,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;
 }
@@ -373,11 +395,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;
     /**
@@ -449,21 +471,39 @@ export interface Order {
      */
     'paymentAttempts'?: Array<PaymentAttempt>;
 }
+/**
+ * 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;
@@ -473,7 +513,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.
@@ -507,11 +553,17 @@ export declare const OrderImportErrorCode: {
     readonly ImportFailed: "IMPORT_FAILED";
 };
 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.
@@ -537,8 +589,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,11 +642,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>;
     /**
@@ -719,6 +780,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.
@@ -729,11 +793,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;
     /**
@@ -835,6 +899,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';
@@ -845,6 +910,9 @@ export type StockConflictError = {
  * 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.
@@ -855,11 +923,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;
     /**
@@ -1003,7 +1071,7 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
     listOrderImports: (project: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * 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
@@ -1136,7 +1204,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
     listOrderImports(project: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderImportsResponse>>;
     /**
      * 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
@@ -1239,7 +1307,7 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
     listOrderImports(requestParameters: OrdersApiListOrderImportsRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrderImportsResponse>;
     /**
      * 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}
@@ -1576,7 +1644,7 @@ export declare class OrdersApi extends BaseAPI {
     listOrderImports(requestParameters: OrdersApiListOrderImportsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderImportsResponse, any, {}>>;
     /**
      * 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}

package/dist/api.js

@@ -5,7 +5,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).
@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GetOrdersDateFilterTypeEnum = exports.ExportOrdersDateFilterTypeEnum = exports.OrdersApi = exports.OrdersApiFactory = exports.OrdersApiFp = exports.OrdersApiAxiosParamCreator = exports.StockUnavailableErrorCodeEnum = exports.Status = exports.ProductUnavailableErrorAvailableQuantityEnum = exports.ProductUnavailableErrorCodeEnum = exports.PaymentAttemptStatusEnum = exports.PaymentAttemptPaymentProviderEnum = exports.OrderImportStatus = exports.OrderImportGroupStatus = exports.OrderImportErrorCode = exports.CustomsInformationPreRegistrationTypeEnum = exports.ConfirmOrderValidationErrorCodeEnum = void 0;
+exports.GetOrdersDateFilterTypeEnum = exports.ExportOrdersDateFilterTypeEnum = exports.OrdersApi = exports.OrdersApiFactory = exports.OrdersApiFp = exports.OrdersApiAxiosParamCreator = exports.StockUnavailableErrorCodeEnum = exports.Status = exports.ProductUnavailableErrorAvailableQuantityEnum = exports.ProductUnavailableErrorCodeEnum = exports.PaymentAttemptStatusEnum = exports.PaymentAttemptPaymentProviderEnum = exports.OrderImportStatus = exports.OrderImportGroupStatus = exports.OrderImportErrorCode = exports.FulfillmentFrozenReasonsEnum = exports.CustomsInformationPreRegistrationTypeEnum = exports.ConfirmOrderValidationErrorCodeEnum = void 0;
 const axios_1 = require("axios");
 // Some imports not used depending on template conditions
 // @ts-ignore
@@ -33,10 +33,20 @@ exports.ConfirmOrderValidationErrorCodeEnum = {
     BadRequest: 'BAD_REQUEST',
     PaymentFailed: 'PAYMENT_FAILED',
     Conflict: 'CONFLICT',
-    ActionRequired: 'ACTION_REQUIRED'
+    ActionRequired: 'ACTION_REQUIRED',
 };
 exports.CustomsInformationPreRegistrationTypeEnum = {
-    Ioss: 'IOSS'
+    Ioss: 'IOSS',
+};
+exports.FulfillmentFrozenReasonsEnum = {
+    Moderation: 'moderation',
+    InternalScreenPrint: 'internal_screen_print',
+    Manual: 'manual',
+    CreditControl: 'credit_control',
+    BillingFailed: 'billing_failed',
+    PickfaceFlagged: 'pickface_flagged',
+    FlowFrozen: 'flow_frozen',
+    Fraud: 'fraud',
 };
 /**
  * Machine-readable error code identifying the type of import failure: - `VARIANT_NOT_FOUND` — The SKU does not match any variant in the project\'s catalog - `MISSING_SKU` — A required SKU field was empty or missing - `SHIPPING_METHOD_UNAVAILABLE` — No shipping methods are available for the fulfillment - `TRANSIENT_SYSTEM_ERROR` — A temporary system issue occurred; the import may succeed on retry - `IMPORT_FAILED` — A general import failure that does not match a more specific code
@@ -46,7 +56,7 @@ exports.OrderImportErrorCode = {
     MissingSku: 'MISSING_SKU',
     ShippingMethodUnavailable: 'SHIPPING_METHOD_UNAVAILABLE',
     TransientSystemError: 'TRANSIENT_SYSTEM_ERROR',
-    ImportFailed: 'IMPORT_FAILED'
+    ImportFailed: 'IMPORT_FAILED',
 };
 /**
  * The lifecycle status of a single group (order) within an import: - `pending` — Group is queued and has not started processing - `processing` — Group is currently being processed - `success` — Order was created and confirmed successfully - `failed` — Order creation or confirmation failed - `cancelled` — Group was cancelled (e.g. parent import was cancelled)
@@ -56,7 +66,7 @@ exports.OrderImportGroupStatus = {
     Processing: 'processing',
     Success: 'success',
     Failed: 'failed',
-    Cancelled: 'cancelled'
+    Cancelled: 'cancelled',
 };
 /**
  * The lifecycle status of an order import: - `queued` — Import has been accepted but no groups have started processing yet - `processing` — One or more groups are currently being processed - `completedSuccess` — All groups were imported successfully - `completedPartial` — Some groups succeeded but others failed or were cancelled - `completedFailed` — All groups failed or were cancelled, with none succeeding - `cancelled` — The entire import was cancelled before completion
@@ -67,24 +77,24 @@ exports.OrderImportStatus = {
     CompletedSuccess: 'completedSuccess',
     CompletedPartial: 'completedPartial',
     CompletedFailed: 'completedFailed',
-    Cancelled: 'cancelled'
+    Cancelled: 'cancelled',
 };
 exports.PaymentAttemptPaymentProviderEnum = {
     Stripe: 'stripe',
     Paypal: 'paypal',
-    Wallet: 'wallet'
+    Wallet: 'wallet',
 };
 exports.PaymentAttemptStatusEnum = {
     Success: 'success',
     Failed: 'failed',
     Pending: 'pending',
-    Cancelled: 'cancelled'
+    Cancelled: 'cancelled',
 };
 exports.ProductUnavailableErrorCodeEnum = {
-    ProductUnavailable: 'PRODUCT_UNAVAILABLE'
+    ProductUnavailable: 'PRODUCT_UNAVAILABLE',
 };
 exports.ProductUnavailableErrorAvailableQuantityEnum = {
-    NUMBER_0: 0
+    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
@@ -96,10 +106,10 @@ exports.Status = {
     Complete: 'complete',
     Refunded: 'refunded',
     Quote: 'quote',
-    Moderation: 'moderation'
+    Moderation: 'moderation',
 };
 exports.StockUnavailableErrorCodeEnum = {
-    StockUnavailable: 'STOCK_UNAVAILABLE'
+    StockUnavailable: 'STOCK_UNAVAILABLE',
 };
 /**
  * OrdersApi - axios parameter creator
@@ -652,7 +662,7 @@ const OrdersApiAxiosParamCreator = function (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
@@ -912,7 +922,7 @@ const OrdersApiFp = function (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
@@ -1049,7 +1059,7 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
         },
         /**
          * 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}
@@ -1176,7 +1186,7 @@ class OrdersApi extends base_1.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}
@@ -1193,7 +1203,7 @@ exports.ExportOrdersDateFilterTypeEnum = {
     StatusChangedAt: 'statusChangedAt',
     CompletedAt: 'completedAt',
     RefundedAt: 'refundedAt',
-    QuoteAt: 'quoteAt'
+    QuoteAt: 'quoteAt',
 };
 exports.GetOrdersDateFilterTypeEnum = {
     CreatedAt: 'createdAt',
@@ -1202,5 +1212,5 @@ exports.GetOrdersDateFilterTypeEnum = {
     StatusChangedAt: 'statusChangedAt',
     CompletedAt: 'completedAt',
     RefundedAt: 'refundedAt',
-    QuoteAt: 'quoteAt'
+    QuoteAt: 'quoteAt',
 };

package/dist/base.d.ts

@@ -2,7 +2,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/dist/base.js

@@ -5,7 +5,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/dist/common.d.ts

@@ -2,7 +2,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/dist/common.js

@@ -5,7 +5,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/dist/configuration.d.ts

@@ -2,7 +2,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/dist/configuration.js

@@ -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).