@teemill/orders 1.26.0 → 1.28.2

package/dist/esm/api.d.ts

@@ -1,8 +1,8 @@
 /**
- * Orders API
+ * 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.26.0
+ * The version of the OpenAPI document: 1.28.2
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -354,7 +354,7 @@ export interface Image {
 }
 export interface ImportOrders202Response {
     /**
-     * Id of the order import
+     * Unique object identifier
      */
     'importId'?: string;
 }
@@ -449,6 +449,129 @@ export interface Order {
      */
     'paymentAttempts'?: Array<PaymentAttempt>;
 }
+export interface OrderImport {
+    /**
+     * Unique object identifier
+     */
+    'importId': string;
+    'status': OrderImportStatus;
+    'counts': OrderImportCounts;
+    /**
+     * ISO 8601 Timestamp
+     */
+    'createdAt': string;
+    'cancelledAt'?: string | null;
+    'startedAt'?: string | null;
+    'finishedAt'?: string | null;
+}
+export interface OrderImportCounts {
+    'total': number;
+    'pending': number;
+    'processing': number;
+    'success': number;
+    'failed': number;
+    'cancelled': number;
+    'completed': number;
+}
+export interface OrderImportError {
+    'code': OrderImportErrorCode;
+    /**
+     * A human-readable description of the error.
+     */
+    'message': string;
+    /**
+     * Dot-notation path to the field that caused the error (e.g. `items.sku`).
+     */
+    'fieldPath'?: string | null;
+    /**
+     * The SKU that triggered the error, if applicable.
+     */
+    'sku'?: string | null;
+    /**
+     * A human-readable suggestion for how to resolve the error.
+     */
+    'suggestedFix'?: string | null;
+    /**
+     * A unique reference code for this error occurrence, useful for support enquiries.
+     */
+    'referenceCode'?: string | null;
+}
+/**
+ * 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
+ */
+export declare const OrderImportErrorCode: {
+    readonly VariantNotFound: "VARIANT_NOT_FOUND";
+    readonly MissingSku: "MISSING_SKU";
+    readonly ShippingMethodUnavailable: "SHIPPING_METHOD_UNAVAILABLE";
+    readonly TransientSystemError: "TRANSIENT_SYSTEM_ERROR";
+    readonly ImportFailed: "IMPORT_FAILED";
+};
+export type OrderImportErrorCode = typeof OrderImportErrorCode[keyof typeof OrderImportErrorCode];
+export interface OrderImportGroup {
+    /**
+     * Unique object identifier
+     */
+    'id': string;
+    'status': OrderImportGroupStatus;
+    /**
+     * The merchant reference from the CSV rows belonging to this group.
+     */
+    'merchantReference'?: string | null;
+    /**
+     * A URI reference to the order created by this group. Only present when the group status is `success`.
+     */
+    'resultReference'?: string | null;
+    /**
+     * A human-readable message describing the outcome of this group.
+     */
+    'message'?: string | null;
+    /**
+     * The number of CSV rows that belong to this group.
+     */
+    'rowsCount': number;
+    /**
+     * The distinct SKUs referenced by rows in this group.
+     */
+    'skus': Array<string>;
+    /**
+     * Errors encountered while processing this group. Empty when the group succeeded.
+     */
+    'errors': Array<OrderImportError>;
+    'createdAt'?: string | null;
+    'startedAt'?: string | null;
+    'finishedAt'?: string | null;
+}
+/**
+ * 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)
+ */
+export declare const OrderImportGroupStatus: {
+    readonly Pending: "pending";
+    readonly Processing: "processing";
+    readonly Success: "success";
+    readonly Failed: "failed";
+    readonly Cancelled: "cancelled";
+};
+export type OrderImportGroupStatus = typeof OrderImportGroupStatus[keyof typeof OrderImportGroupStatus];
+export interface OrderImportGroupsResponse {
+    'groups'?: Array<OrderImportGroup>;
+    'nextPageToken'?: number | null;
+}
+/**
+ * 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
+ */
+export declare const OrderImportStatus: {
+    readonly Queued: "queued";
+    readonly Processing: "processing";
+    readonly CompletedSuccess: "completedSuccess";
+    readonly CompletedPartial: "completedPartial";
+    readonly CompletedFailed: "completedFailed";
+    readonly Cancelled: "cancelled";
+};
+export type OrderImportStatus = typeof OrderImportStatus[keyof typeof OrderImportStatus];
+export interface OrderImportsResponse {
+    'imports'?: Array<OrderImport>;
+    'nextPageToken'?: number | null;
+}
 /**
  * A line item in an order, representing a specific product variant and quantity.
  */
@@ -807,10 +930,11 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
      * @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 {ExportOrdersDateFilterTypeEnum} [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}
      */
-    exportOrders: (project: string, start: string, end?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    exportOrders: (project: string, start: string, end?: string, search?: string, dateFilterType?: ExportOrdersDateFilterTypeEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get an order by a given ID.
      * @summary Get order
@@ -821,6 +945,15 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     getOrder: (project: string, orderId: string, fields?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Gets the latest status and summary for an order import.
+     * @summary Get order import
+     * @param {string} project The project identifier to scope the request to.
+     * @param {string} importId Unique identifier of an order import
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrderImport: (project: string, importId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Lists all orders placed on this project, paginated into configurable chunks.
      * @summary List orders
@@ -839,7 +972,7 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
      */
     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>;
     /**
-     * Initiates an order import from a CSV file. The import is processed asynchronously.
+     * Initiates an order import from a CSV file. The import is processed asynchronously. Use the returned `importId` with the GET endpoints to track progress.
      * @summary Import orders
      * @param {string} project The project identifier to scope the request to.
      * @param {File} file CSV file containing order data
@@ -847,6 +980,27 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     importOrders: (project: string, file: File, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Lists group-level outcomes for a specific order import. Each group represents one order from the CSV (grouped by merchant reference).
+     * @summary List order import groups
+     * @param {string} project The project identifier to scope the request to.
+     * @param {string} importId Unique identifier of an order import
+     * @param {number} [pageToken] Page reference token
+     * @param {number} [pageSize] Max page size for import endpoints. This is the maximum that will be returned, but it might be smaller.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listOrderImportGroups: (project: string, importId: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Lists recent order imports for this project, ordered by most recent first.
+     * @summary List order imports
+     * @param {string} project The project identifier to scope the request to.
+     * @param {number} [pageToken] Page reference token
+     * @param {number} [pageSize] Max page size for import endpoints. This is the maximum that will be returned, but it might be smaller.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listOrderImports: (project: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Retries failed platform payment, so fulfillment can proceed.
      * @summary Retry
@@ -909,10 +1063,11 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
      * @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 {ExportOrdersDateFilterTypeEnum} [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}
      */
-    exportOrders(project: string, start: string, end?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
+    exportOrders(project: string, start: string, end?: string, search?: string, dateFilterType?: ExportOrdersDateFilterTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
     /**
      * Get an order by a given ID.
      * @summary Get order
@@ -923,6 +1078,15 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getOrder(project: string, orderId: string, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
+    /**
+     * Gets the latest status and summary for an order import.
+     * @summary Get order import
+     * @param {string} project The project identifier to scope the request to.
+     * @param {string} importId Unique identifier of an order import
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrderImport(project: string, importId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderImport>>;
     /**
      * Lists all orders placed on this project, paginated into configurable chunks.
      * @summary List orders
@@ -941,7 +1105,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
      */
     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>>;
     /**
-     * Initiates an order import from a CSV file. The import is processed asynchronously.
+     * Initiates an order import from a CSV file. The import is processed asynchronously. Use the returned `importId` with the GET endpoints to track progress.
      * @summary Import orders
      * @param {string} project The project identifier to scope the request to.
      * @param {File} file CSV file containing order data
@@ -949,6 +1113,27 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     importOrders(project: string, file: File, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImportOrders202Response>>;
+    /**
+     * Lists group-level outcomes for a specific order import. Each group represents one order from the CSV (grouped by merchant reference).
+     * @summary List order import groups
+     * @param {string} project The project identifier to scope the request to.
+     * @param {string} importId Unique identifier of an order import
+     * @param {number} [pageToken] Page reference token
+     * @param {number} [pageSize] Max page size for import endpoints. This is the maximum that will be returned, but it might be smaller.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listOrderImportGroups(project: string, importId: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderImportGroupsResponse>>;
+    /**
+     * Lists recent order imports for this project, ordered by most recent first.
+     * @summary List order imports
+     * @param {string} project The project identifier to scope the request to.
+     * @param {number} [pageToken] Page reference token
+     * @param {number} [pageSize] Max page size for import endpoints. This is the maximum that will be returned, but it might be smaller.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    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
@@ -1012,6 +1197,14 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     getOrder(requestParameters: OrdersApiGetOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order>;
+    /**
+     * Gets the latest status and summary for an order import.
+     * @summary Get order import
+     * @param {OrdersApiGetOrderImportRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrderImport(requestParameters: OrdersApiGetOrderImportRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrderImport>;
     /**
      * Lists all orders placed on this project, paginated into configurable chunks.
      * @summary List orders
@@ -1021,13 +1214,29 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
      */
     getOrders(requestParameters: OrdersApiGetOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrdersResponse>;
     /**
-     * Initiates an order import from a CSV file. The import is processed asynchronously.
+     * Initiates an order import from a CSV file. The import is processed asynchronously. Use the returned `importId` with the GET endpoints to track progress.
      * @summary Import orders
      * @param {OrdersApiImportOrdersRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     importOrders(requestParameters: OrdersApiImportOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<ImportOrders202Response>;
+    /**
+     * Lists group-level outcomes for a specific order import. Each group represents one order from the CSV (grouped by merchant reference).
+     * @summary List order import groups
+     * @param {OrdersApiListOrderImportGroupsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listOrderImportGroups(requestParameters: OrdersApiListOrderImportGroupsRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrderImportGroupsResponse>;
+    /**
+     * Lists recent order imports for this project, ordered by most recent first.
+     * @summary List order imports
+     * @param {OrdersApiListOrderImportsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listOrderImports(requestParameters: OrdersApiListOrderImportsRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrderImportsResponse>;
     /**
      * Retries failed platform payment, so fulfillment can proceed.
      * @summary Retry
@@ -1125,6 +1334,10 @@ export interface OrdersApiExportOrdersRequest {
      * Search term to filter based on order reference, customer name and email
      */
     readonly search?: string;
+    /**
+     * Specifies the type of date range filter to apply. Determines which date field the &#x60;start&#x60; and &#x60;end&#x60; fields should query.
+     */
+    readonly dateFilterType?: ExportOrdersDateFilterTypeEnum;
 }
 /**
  * Request parameters for getOrder operation in OrdersApi.
@@ -1143,6 +1356,19 @@ export interface OrdersApiGetOrderRequest {
      */
     readonly fields?: string;
 }
+/**
+ * Request parameters for getOrderImport operation in OrdersApi.
+ */
+export interface OrdersApiGetOrderImportRequest {
+    /**
+     * The project identifier to scope the request to.
+     */
+    readonly project: string;
+    /**
+     * Unique identifier of an order import
+     */
+    readonly importId: string;
+}
 /**
  * Request parameters for getOrders operation in OrdersApi.
  */
@@ -1201,6 +1427,44 @@ export interface OrdersApiImportOrdersRequest {
      */
     readonly file: File;
 }
+/**
+ * Request parameters for listOrderImportGroups operation in OrdersApi.
+ */
+export interface OrdersApiListOrderImportGroupsRequest {
+    /**
+     * The project identifier to scope the request to.
+     */
+    readonly project: string;
+    /**
+     * Unique identifier of an order import
+     */
+    readonly importId: string;
+    /**
+     * Page reference token
+     */
+    readonly pageToken?: number;
+    /**
+     * Max page size for import endpoints. This is the maximum that will be returned, but it might be smaller.
+     */
+    readonly pageSize?: number;
+}
+/**
+ * Request parameters for listOrderImports operation in OrdersApi.
+ */
+export interface OrdersApiListOrderImportsRequest {
+    /**
+     * The project identifier to scope the request to.
+     */
+    readonly project: string;
+    /**
+     * Page reference token
+     */
+    readonly pageToken?: number;
+    /**
+     * Max page size for import endpoints. This is the maximum that will be returned, but it might be smaller.
+     */
+    readonly pageSize?: number;
+}
 /**
  * Request parameters for retryPlatformPayment operation in OrdersApi.
  */
@@ -1270,6 +1534,14 @@ export declare class OrdersApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getOrder(requestParameters: OrdersApiGetOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any, {}>>;
+    /**
+     * Gets the latest status and summary for an order import.
+     * @summary Get order import
+     * @param {OrdersApiGetOrderImportRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrderImport(requestParameters: OrdersApiGetOrderImportRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderImport, any, {}>>;
     /**
      * Lists all orders placed on this project, paginated into configurable chunks.
      * @summary List orders
@@ -1279,13 +1551,29 @@ export declare class OrdersApi extends BaseAPI {
      */
     getOrders(requestParameters: OrdersApiGetOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrdersResponse, any, {}>>;
     /**
-     * Initiates an order import from a CSV file. The import is processed asynchronously.
+     * Initiates an order import from a CSV file. The import is processed asynchronously. Use the returned `importId` with the GET endpoints to track progress.
      * @summary Import orders
      * @param {OrdersApiImportOrdersRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     importOrders(requestParameters: OrdersApiImportOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImportOrders202Response, any, {}>>;
+    /**
+     * Lists group-level outcomes for a specific order import. Each group represents one order from the CSV (grouped by merchant reference).
+     * @summary List order import groups
+     * @param {OrdersApiListOrderImportGroupsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listOrderImportGroups(requestParameters: OrdersApiListOrderImportGroupsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderImportGroupsResponse, any, {}>>;
+    /**
+     * Lists recent order imports for this project, ordered by most recent first.
+     * @summary List order imports
+     * @param {OrdersApiListOrderImportsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listOrderImports(requestParameters: OrdersApiListOrderImportsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderImportsResponse, any, {}>>;
     /**
      * Retries failed platform payment, so fulfillment can proceed.
      * @summary Retry
@@ -1295,9 +1583,23 @@ export declare class OrdersApi extends BaseAPI {
      */
     retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any, {}>>;
 }
+export declare const ExportOrdersDateFilterTypeEnum: {
+    readonly CreatedAt: "createdAt";
+    readonly UpdatedAt: "updatedAt";
+    readonly PaidAt: "paidAt";
+    readonly StatusChangedAt: "statusChangedAt";
+    readonly CompletedAt: "completedAt";
+    readonly RefundedAt: "refundedAt";
+    readonly QuoteAt: "quoteAt";
+};
+export type ExportOrdersDateFilterTypeEnum = typeof ExportOrdersDateFilterTypeEnum[keyof typeof ExportOrdersDateFilterTypeEnum];
 export declare const GetOrdersDateFilterTypeEnum: {
     readonly CreatedAt: "createdAt";
     readonly UpdatedAt: "updatedAt";
+    readonly PaidAt: "paidAt";
     readonly StatusChangedAt: "statusChangedAt";
+    readonly CompletedAt: "completedAt";
+    readonly RefundedAt: "refundedAt";
+    readonly QuoteAt: "quoteAt";
 };
 export type GetOrdersDateFilterTypeEnum = typeof GetOrdersDateFilterTypeEnum[keyof typeof GetOrdersDateFilterTypeEnum];