@acmekit/types 2.13.1

package/dist/http/order/admin/payload.d.ts

@@ -0,0 +1,190 @@
+export interface AdminUpdateOrder {
+    /**
+     * The order's email.
+     */
+    email?: string;
+    /**
+     * The order's shipping address.
+     */
+    shipping_address?: OrderAddress;
+    /**
+     * The order's billing address.
+     */
+    billing_address?: OrderAddress;
+    /**
+     * The order's locale code. Items in the
+     * order will be translated to the given locale,
+     * if translations are available.
+     *
+     * @since 2.12.3
+     */
+    locale?: string | null;
+    /**
+     * The order's metadata.
+     */
+    metadata?: Record<string, unknown> | null;
+}
+export interface AdminCreateOrderFulfillment {
+    /**
+     * The items to add to the fulfillment.
+     */
+    items: {
+        /**
+         * The order item's ID.
+         */
+        id: string;
+        /**
+         * The quantity to fulfill.
+         */
+        quantity: number;
+    }[];
+    /**
+     * The ID of the stock location
+     * to fulfill the items from.
+     */
+    location_id?: string;
+    /**
+     * The ID of the shipping option to use for the fulfillment.
+     * Overrides the shipping option selected by the customer.
+     */
+    shipping_option_id?: string;
+    /**
+     * Whether to notify the customer about this change.
+     */
+    no_notification?: boolean;
+    /**
+     * Key-value pairs of custom data.
+     */
+    metadata?: Record<string, any>;
+}
+export interface AdminCreateOrderShipment {
+    /**
+     * The fulfillment items to create a shipment for.
+     */
+    items: {
+        /**
+         * The item's ID.
+         */
+        id: string;
+        /**
+         * The quantity to ship.
+         */
+        quantity: number;
+    }[];
+    /**
+     * The shipment's labels.
+     */
+    labels?: {
+        /**
+         * The label's tracking number.
+         */
+        tracking_number: string;
+        /**
+         * The label's tracking URL.
+         */
+        tracking_url: string;
+        /**
+         * The label's URL.
+         */
+        label_url: string;
+    }[];
+    /**
+     * Whether to notify the customer about this change.
+     */
+    no_notification?: boolean;
+    /**
+     * Key-value pairs of custom data.
+     */
+    metadata?: Record<string, any>;
+}
+export interface AdminCancelOrderFulfillment {
+    /**
+     * Whether to notify the customer about this change.
+     */
+    no_notification?: boolean;
+}
+export interface AdminRequestOrderTransfer {
+    /**
+     * The ID of the customer to transfer the order to.
+     */
+    customer_id: string;
+    /**
+     * An internal note viewed by admins only.
+     */
+    internal_note?: string;
+    /**
+     * A description for the transfer request.
+     */
+    description?: string;
+}
+export interface OrderAddress {
+    /**
+     * The first name of the address.
+     */
+    first_name?: string;
+    /**
+     * The last name of the address.
+     */
+    last_name?: string;
+    /**
+     * The phone number of the address.
+     */
+    phone?: string;
+    /**
+     * The company of the address.
+     */
+    company?: string;
+    /**
+     * The first address line of the address.
+     */
+    address_1?: string;
+    /**
+     * The second address line of the address.
+     */
+    address_2?: string;
+    /**
+     * The city of the address.
+     */
+    city?: string;
+    /**
+     * The country code of the address.
+     */
+    country_code?: string;
+    /**
+     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province/state of the address.
+     */
+    province?: string;
+    /**
+     * The postal code of the address.
+     */
+    postal_code?: string;
+    /**
+     * Holds custom data in key-value pairs.
+     */
+    metadata?: Record<string, unknown> | null;
+}
+export interface AdminCreateOrderCreditLine {
+    /**
+     * The amount of the credit line.
+     */
+    amount: number;
+    /**
+     * The name of the table this credit line is associated with.
+     */
+    reference: string;
+    /**
+     * The ID of the reference entity in the reference table.
+     */
+    reference_id: string;
+    /**
+     * Key-value pairs of custom data.
+     */
+    metadata?: Record<string, unknown> | null;
+}
+export interface AdminUpdateOrderChange {
+    /**
+     * Whether to carry over promotions to outbound exchange items.
+     */
+    carry_over_promotions?: boolean;
+}
+//# sourceMappingURL=payload.d.ts.map

package/dist/http/order/admin/payload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../src/http/order/admin/payload.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,gBAAgB,CAAC,EAAE,YAAY,CAAA;IAC/B;;OAEG;IACH,eAAe,CAAC,EAAE,YAAY,CAAA;IAC9B;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,KAAK,EAAE;QACL;;WAEG;QACH,EAAE,EAAE,MAAM,CAAA;QACV;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAA;KACjB,EAAE,CAAA;IACH;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,KAAK,EAAE;QACL;;WAEG;QACH,EAAE,EAAE,MAAM,CAAA;QACV;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAA;KACjB,EAAE,CAAA;IACH;;OAEG;IACH,MAAM,CAAC,EAAE;QACP;;WAEG;QACH,eAAe,EAAE,MAAM,CAAA;QACvB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAA;QACpB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAA;KAClB,EAAE,CAAA;IACH;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;CAC1B;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAA;CAChC"}

package/dist/http/order/admin/payload.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=payload.js.map

package/dist/http/order/admin/payload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.js","sourceRoot":"","sources":["../../../../src/http/order/admin/payload.ts"],"names":[],"mappings":""}

package/dist/http/order/admin/queries.d.ts

@@ -0,0 +1,72 @@
+import { OperatorMap } from "../../../dal";
+import { FindParams, SelectParams } from "../../common";
+import { BaseOrderChangesFilters, BaseOrderFilters } from "../common";
+export interface AdminOrderFilters extends FindParams, BaseOrderFilters {
+    /**
+     * Filter by order ID(s).
+     */
+    id?: string[] | string;
+    /**
+     * Filter by sales channel IDs to retrieve their associated orders.
+     */
+    sales_channel_id?: string[];
+    /**
+     * Filter by region IDs to retrieve their associated orders.
+     */
+    region_id?: string[] | string;
+    /**
+     * Filter by customer IDs to retrieve their associated orders.
+     */
+    customer_id?: string[] | string;
+    /**
+     * Query or keywords to filter the order's searchable fields.
+     */
+    q?: string;
+    /**
+     * Apply filters on the fulfillment's creation date.
+     */
+    created_at?: OperatorMap<string>;
+    /**
+     * Apply filters on the fulfillment's update date.
+     */
+    updated_at?: OperatorMap<string>;
+}
+export interface AdminOrderItemsFilters extends SelectParams {
+    /**
+     * Filter by order item ID(s).
+     */
+    id?: string[] | string;
+    /**
+     * Filter by the associated line item ID(s).
+     */
+    item_id?: string[] | string;
+    /**
+     * Filter by order version(s).
+     */
+    version?: number[] | number;
+}
+export interface AdminOrderChangesFilters extends BaseOrderChangesFilters, SelectParams {
+    /**
+     * Apply filters on the change's creation date.
+     */
+    created_at?: OperatorMap<string>;
+    /**
+     * Apply filters on the change's update date.
+     */
+    updated_at?: OperatorMap<string>;
+    /**
+     * Apply filters on the change's deletion date.
+     */
+    deleted_at?: OperatorMap<string>;
+}
+export interface AdminGetOrderShippingOptionList {
+}
+export interface AdminGetOrderParams extends SelectParams {
+}
+export interface AdminGetOrderDetailsParams extends SelectParams {
+    /**
+     * The version of the order to retrieve details for.
+     */
+    version?: number;
+}
+//# sourceMappingURL=queries.d.ts.map

package/dist/http/order/admin/queries.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/order/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1C,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AACvD,OAAO,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAA;AAErE,MAAM,WAAW,iBAAkB,SAAQ,UAAU,EAAE,gBAAgB;IACrE;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IACtB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IAC7B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IAC/B;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CACjC;AAED,MAAM,WAAW,sBAAuB,SAAQ,YAAY;IAC1D;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IACtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IAC3B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;CAC5B;AAED,MAAM,WAAW,wBAAyB,SAAQ,uBAAuB,EAAE,YAAY;IACrF;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CACjC;AAED,MAAM,WAAW,+BAA+B;CAAG;AACnD,MAAM,WAAW,mBAAoB,SAAQ,YAAY;CAAG;AAC5D,MAAM,WAAW,0BAA2B,SAAQ,YAAY;IAC9D;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB"}

package/dist/http/order/admin/queries.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=queries.js.map

package/dist/http/order/admin/queries.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"queries.js","sourceRoot":"","sources":["../../../../src/http/order/admin/queries.ts"],"names":[],"mappings":""}

package/dist/http/order/admin/responses.d.ts

@@ -0,0 +1,45 @@
+import { PaginatedResponse } from "../../common";
+import { AdminOrder, AdminOrderChange, AdminOrderItem, AdminOrderPreview } from "./entities";
+export interface AdminOrderResponse {
+    /**
+     * The order's details.
+     */
+    order: AdminOrder;
+}
+export interface AdminOrderChangesResponse {
+    /**
+     * The list of order changes.
+     */
+    order_changes: AdminOrderChange[];
+}
+export interface AdminOrderChangeResponse {
+    /**
+     * The order change's details.
+     */
+    order_change: AdminOrderChange;
+}
+export type AdminOrderListResponse = PaginatedResponse<{
+    /**
+     * The list of orders.
+     */
+    orders: AdminOrder[];
+}>;
+export type AdminOrderLineItemsListResponse = {
+    /**
+     * The list of order items.
+     */
+    order_items: AdminOrderItem[];
+};
+export interface AdminOrderPreviewResponse {
+    /**
+     * A preview of the order if the latest change, such as exchange, return, edit, or claim is applied on it.
+     */
+    order: AdminOrderPreview;
+}
+export interface AdminExportOrderResponse {
+    /**
+     * The ID of the export order workflow's transaction.
+     */
+    transaction_id: string;
+}
+//# sourceMappingURL=responses.d.ts.map

package/dist/http/order/admin/responses.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/order/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChD,OAAO,EACL,UAAU,EACV,gBAAgB,EAChB,cAAc,EACd,iBAAiB,EAClB,MAAM,YAAY,CAAA;AAEnB,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,KAAK,EAAE,UAAU,CAAA;CAClB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,aAAa,EAAE,gBAAgB,EAAE,CAAA;CAClC;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,YAAY,EAAE,gBAAgB,CAAA;CAC/B;AAED,MAAM,MAAM,sBAAsB,GAAG,iBAAiB,CAAC;IACrD;;OAEG;IACH,MAAM,EAAE,UAAU,EAAE,CAAA;CACrB,CAAC,CAAA;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C;;OAEG;IACH,WAAW,EAAE,cAAc,EAAE,CAAA;CAC9B,CAAA;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,KAAK,EAAE,iBAAiB,CAAA;CACzB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAA;CACvB"}

package/dist/http/order/admin/responses.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=responses.js.map

package/dist/http/order/admin/responses.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"responses.js","sourceRoot":"","sources":["../../../../src/http/order/admin/responses.ts"],"names":[],"mappings":""}