@acmekit/types 2.13.1

package/dist/workflow/order/items.d.ts

@@ -0,0 +1,323 @@
+import { ClaimReason } from "../../order/mutations";
+import { BigNumberInput } from "../../totals";
+/**
+ * The details of a line item to add to an order.
+ */
+interface NewItem {
+    /**
+     * The ID of the variant to add to the order.
+     */
+    variant_id?: string;
+    /**
+     * The title of the item to add to the order.
+     */
+    title?: string;
+    /**
+     * The quantity of the item to add to the order.
+     */
+    quantity: BigNumberInput;
+    /**
+     * The price of a single quantity of the item.
+     */
+    unit_price?: BigNumberInput | null;
+    /**
+     * The original price of the item before a promotion or sale.
+     */
+    compare_at_unit_price?: BigNumberInput | null;
+    /**
+     * A note viewed by admins only related to the item.
+     */
+    internal_note?: string | null;
+    /**
+     * Custom key-value pairs to store additional information about the item.
+     */
+    metadata?: Record<string, any> | null;
+}
+/**
+ * The details of an existing item in an order.
+ */
+interface ExistingItem {
+    /**
+     * The ID of the order item.
+     */
+    id: string;
+    /**
+     * The item's quantity.
+     */
+    quantity: BigNumberInput;
+    /**
+     * The price of a single quantity of the item.
+     */
+    unit_price?: BigNumberInput | null;
+    /**
+     * The original price of the item before a promotion or sale.
+     */
+    compare_at_unit_price?: BigNumberInput | null;
+    /**
+     * A note viewed by admins only related to the item.
+     */
+    internal_note?: string | null;
+}
+/**
+ * The details of the outbound or new items to add to an exchange.
+ */
+export interface OrderExchangeAddNewItemWorkflowInput {
+    /**
+     * The ID of the exchange to add the items to.
+     */
+    exchange_id: string;
+    /**
+     * The items to add to the exchange.
+     */
+    items: NewItem[];
+}
+/**
+ * The details of the outbound or new items to add to a claim.
+ */
+export interface OrderClaimAddNewItemWorkflowInput {
+    /**
+     * The ID of the claim to add the items to.
+     */
+    claim_id: string;
+    /**
+     * The items to add to the claim.
+     */
+    items: NewItem[];
+}
+/**
+ * The details of the items to add to an order edit.
+ */
+export interface OrderEditAddNewItemWorkflowInput {
+    /**
+     * The ID of the order to add the items to its edit.
+     */
+    order_id: string;
+    /**
+     * The items to add to the order's edit.
+     */
+    items: NewItem[];
+}
+/**
+ * The details of updating an order items' quantity in the order's edit.
+ */
+export interface OrderEditUpdateItemQuantityWorkflowInput {
+    /**
+     * The ID of the order to update the items in its edit.
+     */
+    order_id: string;
+    /**
+     * The order items to update their quantity in the order's edit.
+     */
+    items: ExistingItem[];
+}
+/**
+ * The details of the line items to add to the order.
+ */
+export interface OrderAddLineItemWorkflowInput {
+    /**
+     * The ID of the order to add the line items to.
+     */
+    order_id: string;
+    /**
+     * The items to add to the order.
+     */
+    items: NewItem[];
+}
+/**
+ * The details of the outbound or new item to update in an order.
+ */
+export interface UpdateExchangeAddNewItemWorkflowInput {
+    /**
+     * The ID of the exchange to update the item in.
+     */
+    exchange_id: string;
+    /**
+     * The ID of the action associated with the item to update.
+     * Every item has an `actions` property, whose value is an array of actions.
+     * You can find the action with the name `ITEM_ADD` using the item's `action` property,
+     * and use the value of the action's `id` property.
+     */
+    action_id: string;
+    /**
+     * The data to update in the item.
+     */
+    data: {
+        /**
+         * The new quantity of the item.
+         */
+        quantity?: BigNumberInput;
+        /**
+         * A note viewed by admins only related to the item.
+         */
+        internal_note?: string | null;
+    };
+}
+/**
+ * The details of the item to update in an order edit.
+ */
+export interface UpdateOrderEditAddNewItemWorkflowInput {
+    /**
+     * The ID of the order to update the item in its edit.
+     */
+    order_id: string;
+    /**
+     * The ID of the action associated with the item to update.
+     * Every item has an `actions` property, whose value is an array of actions.
+     * You can find the action with the name `ITEM_ADD` using the item's `action` property,
+     * and use the value of the action's `id` property.
+     */
+    action_id: string;
+    /**
+     * The details to update in the item.
+     */
+    data: {
+        /**
+         * The new quantity of the item.
+         */
+        quantity?: BigNumberInput;
+        /**
+         * The price of a single quantity of the item.
+         */
+        unit_price?: BigNumberInput | null;
+        /**
+         * The original price of the item before a promotion or sale.
+         */
+        compare_at_unit_price?: BigNumberInput | null;
+        /**
+         * A note viewed by admins only related to the item.
+         */
+        internal_note?: string | null;
+    };
+}
+/**
+ * The details to update an existing order item that was added previously to an order edit.
+ */
+export interface UpdateOrderEditItemQuantityWorkflowInput extends UpdateOrderEditAddNewItemWorkflowInput {
+}
+/**
+ * The details to update a claim's outbound item.
+ */
+export interface UpdateClaimAddNewItemWorkflowInput {
+    /**
+     * The ID of the claim to update the outbound item in.
+     */
+    claim_id: string;
+    /**
+     * The ID of the action associated with the item to update.
+     * Every item has an `actions` property, whose value is an array of actions.
+     * You can find the action with the name `ITEM_ADD` using the item's `action` property,
+     * and use the value of the action's `id` property.
+     */
+    action_id: string;
+    /**
+     * The details to update in the outbound item.
+     */
+    data: {
+        /**
+         * The new quantity of the item.
+         */
+        quantity?: BigNumberInput;
+        /**
+         * A note viewed by admins only related to the item.
+         */
+        internal_note?: string | null;
+    };
+}
+export interface OrderExchangeItemWorkflowInput {
+    exchange_id: string;
+    items: ExistingItem[];
+}
+export interface UpdateExchangeAddItemWorkflowInput {
+    exchange_id: string;
+    action_id: string;
+    data: {
+        quantity?: BigNumberInput;
+        internal_note?: string | null;
+    };
+}
+/**
+ * The details of the order items to add to a claim.
+ */
+export interface OrderClaimItemWorkflowInput {
+    /**
+     * The ID of the claim to add the items to.
+     */
+    claim_id: string;
+    /**
+     * The items to add to the claim.
+     */
+    items: (ExistingItem & {
+        /**
+         * The reason for adding the item to the claim.
+         */
+        reason?: ClaimReason;
+    })[];
+}
+/**
+ * The details of the item to update in a claim.
+ */
+export interface UpdateClaimItemWorkflowInput {
+    /**
+     * The ID of the claim to update the item in.
+     */
+    claim_id: string;
+    /**
+     * The ID of the action associated with the item to update.
+     * Every item has an `actions` property, whose value is an array of actions.
+     * You can find the action with the name `WRITE_OFF_ITEM` using its `action` property,
+     * and use the value of its `id` property.
+     */
+    action_id: string;
+    data: {
+        quantity?: BigNumberInput;
+        reason_id?: string | null;
+        internal_note?: string | null;
+    };
+}
+/**
+ * The details of the outbound item to remove from an exchange.
+ */
+export interface DeleteOrderExchangeItemActionWorkflowInput {
+    /**
+     * The ID of the exchange to remove the item from.
+     */
+    exchange_id: string;
+    /**
+     * The ID of the action associated with the item to remove.
+     * Every item has an `actions` property, whose value is an array of actions.
+     * You can find the action with the name `ITEM_ADD` using the item's `action` property,
+     * and use the value of the action's `id` property.
+     */
+    action_id: string;
+}
+/**
+ * The details of the item to remove from a claim.
+ */
+export interface DeleteOrderClaimItemActionWorkflowInput {
+    /**
+     * The ID of the claim to remove the item from.
+     */
+    claim_id: string;
+    /**
+     * The ID of the action associated with the item to remove.
+     */
+    action_id: string;
+}
+/**
+ * The details to remove an item previously added to an order edit.
+ */
+export interface DeleteOrderEditItemActionWorkflowInput {
+    /**
+     * The ID of the order to remove the item from its edit.
+     */
+    order_id: string;
+    /**
+     * The ID of the action associated with the item to remove.
+     * Every item has an `actions` property, whose value is an array of actions.
+     * You can find the action with the name `ITEM_ADD` using the item's `action` property,
+     * and use the value of the action's `id` property.
+     */
+    action_id: string;
+}
+export {};
+//# sourceMappingURL=items.d.ts.map

package/dist/workflow/order/items.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"items.d.ts","sourceRoot":"","sources":["../../../src/workflow/order/items.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACnD,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAE7C;;GAEG;AACH,UAAU,OAAO;IACf;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,QAAQ,EAAE,cAAc,CAAA;IACxB;;OAEG;IACH,UAAU,CAAC,EAAE,cAAc,GAAG,IAAI,CAAA;IAClC;;OAEG;IACH,qBAAqB,CAAC,EAAE,cAAc,GAAG,IAAI,CAAA;IAC7C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAA;CACtC;AAED;;GAEG;AACH,UAAU,YAAY;IACpB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,QAAQ,EAAE,cAAc,CAAA;IACxB;;OAEG;IACH,UAAU,CAAC,EAAE,cAAc,GAAG,IAAI,CAAA;IAClC;;OAEG;IACH,qBAAqB,CAAC,EAAE,cAAc,GAAG,IAAI,CAAA;IAC7C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACnD;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,KAAK,EAAE,OAAO,EAAE,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,KAAK,EAAE,OAAO,EAAE,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,KAAK,EAAE,OAAO,EAAE,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,wCAAwC;IACvD;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,KAAK,EAAE,YAAY,EAAE,CAAA;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,KAAK,EAAE,OAAO,EAAE,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,qCAAqC;IACpD;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,IAAI,EAAE;QACJ;;WAEG;QACH,QAAQ,CAAC,EAAE,cAAc,CAAA;QACzB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KAC9B,CAAA;CACF;AAED;;GAEG;AACH,MAAM,WAAW,sCAAsC;IACrD;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,IAAI,EAAE;QACJ;;WAEG;QACH,QAAQ,CAAC,EAAE,cAAc,CAAA;QACzB;;WAEG;QACH,UAAU,CAAC,EAAE,cAAc,GAAG,IAAI,CAAA;QAClC;;WAEG;QACH,qBAAqB,CAAC,EAAE,cAAc,GAAG,IAAI,CAAA;QAC7C;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KAC9B,CAAA;CACF;AAED;;GAEG;AACH,MAAM,WAAW,wCACf,SAAQ,sCAAsC;CAAG;AAEnD;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,IAAI,EAAE;QACJ;;WAEG;QACH,QAAQ,CAAC,EAAE,cAAc,CAAA;QACzB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KAC9B,CAAA;CACF;AAED,MAAM,WAAW,8BAA8B;IAC7C,WAAW,EAAE,MAAM,CAAA;IACnB,KAAK,EAAE,YAAY,EAAE,CAAA;CACtB;AAED,MAAM,WAAW,kCAAkC;IACjD,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE;QACJ,QAAQ,CAAC,EAAE,cAAc,CAAA;QACzB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KAC9B,CAAA;CACF;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,KAAK,EAAE,CAAC,YAAY,GAAG;QACrB;;WAEG;QACH,MAAM,CAAC,EAAE,WAAW,CAAA;KACrB,CAAC,EAAE,CAAA;CACL;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE;QACJ,QAAQ,CAAC,EAAE,cAAc,CAAA;QACzB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QACzB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KAC9B,CAAA;CACF;AAED;;GAEG;AACH,MAAM,WAAW,0CAA0C;IACzD;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,uCAAuC;IACtD;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,sCAAsC;IACrD;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAA;CAClB"}

package/dist/workflow/order/items.js

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

package/dist/workflow/order/items.js.map

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

package/dist/workflow/order/receive-return.d.ts

@@ -0,0 +1,120 @@
+import { BigNumberInput } from "../../totals";
+/**
+ * The details of an item to be received in a return.
+ */
+interface ReceiveReturnItem {
+    /**
+     * The ID of the order item to receive.
+     */
+    id: string;
+    /**
+     * The quantity of the item to receive.
+     */
+    quantity: BigNumberInput;
+    /**
+     * An internal note viewed only by admin users.
+     */
+    internal_note?: string;
+    /**
+     * Custom key-value pairs of data to store in the return item.
+     */
+    metadata?: Record<string, any> | null;
+}
+/**
+ * The details of a return requested to be received.
+ */
+export interface BeginReceiveOrderReturnWorkflowInput {
+    /**
+     * The ID of the return to receive.
+     */
+    return_id: string;
+    /**
+     * The ID of the user that's requesting the return receival.
+     */
+    created_by?: string;
+    /**
+     * Description of the return receival.
+     */
+    description?: string;
+    /**
+     * A note viewed by admins only related to the return receival.
+     */
+    internal_note?: string;
+    /**
+     * Custom key-value pairs of data to store in the return receival.
+     */
+    metadata?: Record<string, any> | null;
+}
+/**
+ * The data to mark items as received in a return.
+ */
+export interface ReceiveOrderReturnItemsWorkflowInput {
+    /**
+     * The ID of the return to mark its items as received.
+     */
+    return_id: string;
+    /**
+     * The items to mark as received.
+     */
+    items: ReceiveReturnItem[];
+}
+/**
+ * The data to mark a return as received and completed.
+ */
+export interface ReceiveCompleteOrderReturnWorkflowInput {
+    /**
+     * The ID of the return to receive and complete.
+     */
+    return_id: string;
+    /**
+     * The ID of the user that's receiving and completing the return.
+     */
+    created_by?: string;
+    /**
+     * The received items.
+     */
+    items: ReceiveReturnItem[];
+    /**
+     * Description of the return receival.
+     */
+    description?: string;
+    /**
+     * A note viewed by admins only related to the return receival.
+     */
+    internal_note?: string;
+    /**
+     * Custom key-value pairs of data to store in the return receival.
+     */
+    metadata?: Record<string, any> | null;
+}
+/**
+ * The details of updating an item in a return receival request.
+ */
+export interface UpdateReceiveItemReturnRequestWorkflowInput {
+    /**
+     * The ID of the return to update the item in.
+     */
+    return_id: string;
+    /**
+     * The ID of the action associated with the item to update.
+     * Every return item has an `actions` property, whose value is an array of actions.
+     * You can find the action with the name `RECEIVE_RETURN_ITEM` using its `action` property, and use the value of
+     * its `id` property.
+     */
+    action_id: string;
+    /**
+     * The data to update in the item.
+     */
+    data: {
+        /**
+         * The new quantity of the item.
+         */
+        quantity?: BigNumberInput;
+        /**
+         * An internal note viewed only by admin users.
+         */
+        internal_note?: string | null;
+    };
+}
+export {};
+//# sourceMappingURL=receive-return.d.ts.map

package/dist/workflow/order/receive-return.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"receive-return.d.ts","sourceRoot":"","sources":["../../../src/workflow/order/receive-return.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAE7C;;GAEG;AACH,UAAU,iBAAiB;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,QAAQ,EAAE,cAAc,CAAA;IACxB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAA;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACnD;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAA;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACnD;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,KAAK,EAAE,iBAAiB,EAAE,CAAA;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,uCAAuC;IACtD;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,KAAK,EAAE,iBAAiB,EAAE,CAAA;IAC1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAA;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,2CAA2C;IAC1D;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,IAAI,EAAE;QACJ;;WAEG;QACH,QAAQ,CAAC,EAAE,cAAc,CAAA;QACzB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KAC9B,CAAA;CACF"}

package/dist/workflow/order/receive-return.js

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

package/dist/workflow/order/receive-return.js.map

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

package/dist/workflow/order/request-item-return.d.ts

@@ -0,0 +1,140 @@
+import { BigNumberInput } from "../../totals";
+import { CreateReturnItem } from "./create-return-order";
+/**
+ * The details of adding items to a return.
+ */
+export interface RequestItemReturnWorkflowInput {
+    /**
+     * The ID of the return to add the items to.
+     */
+    return_id: string;
+    /**
+     * The ID of the claim associated with the return, if any.
+     */
+    claim_id?: string;
+    /**
+     * The ID of the exchange associated with the return, if any.
+     */
+    exchange_id?: string;
+    /**
+     * The items to add to the return.
+     */
+    items: CreateReturnItem[];
+}
+/**
+ * The details of updating a requested item in a return.
+ */
+export interface UpdateRequestItemReturnWorkflowInput {
+    /**
+     * The ID of the return to update the item in.
+     */
+    return_id: string;
+    /**
+     * The ID of the claim associated with the return, if any.
+     */
+    claim_id?: string;
+    /**
+     * The ID of the exchange associated with the return, if any.
+     */
+    exchange_id?: string;
+    /**
+     * The ID of the action associated with the item to update.
+     * Every item has an `actions` property, whose value is an array of actions.
+     * You can find an action with the name `RETURN_ITEM` using its `action` property,
+     * and use the value of its `id` property.
+     */
+    action_id: string;
+    /**
+     * The data to update in the item.
+     */
+    data: {
+        /**
+         * The new quantity of the item.
+         */
+        quantity?: BigNumberInput;
+        /**
+         * An internal note viewed only by admin users.
+         */
+        internal_note?: string | null;
+        /**
+         * The ID of the reason indicating why the item is being returned.
+         */
+        reason_id?: string | null;
+    };
+}
+/**
+ * The details to return an item as part of an exchange.
+ */
+export interface OrderExchangeRequestItemReturnWorkflowInput {
+    /**
+     * The ID of the return that's associated with the exchange.
+     */
+    return_id: string;
+    /**
+     * The ID of the location to return the items to.
+     */
+    location_id?: string;
+    /**
+     * The ID of the exchange to add the inbound items to.
+     */
+    exchange_id: string;
+    /**
+     * The items to return as part of the exchange.
+     */
+    items: CreateReturnItem[];
+}
+export interface DeleteOrderExchangeRequestItemReturnWorkflowInput {
+    return_id: string;
+    action_id: string;
+}
+/**
+ * The details of the items to be returned as part of the claim.
+ */
+export interface OrderClaimRequestItemReturnWorkflowInput {
+    /**
+     * The ID of the return that's associated with the claim.
+     */
+    return_id: string;
+    /**
+     * The ID of the location to return the items to.
+     */
+    location_id?: string;
+    /**
+     * The ID of the claim to add the items to.
+     */
+    claim_id: string;
+    /**
+     * The items to add to the claim as inbound items.
+     */
+    items: CreateReturnItem[];
+}
+/**
+ * The details of the item to be removed from the return.
+ */
+export interface DeleteRequestItemReturnWorkflowInput {
+    /**
+     * The ID of the return to remove the item from.
+     */
+    return_id: string;
+    /**
+     * The ID of the action associated with the item to remove.
+     * Every item has an `actions` property, whose value is an array of actions.
+     * You can find an action with the name `RETURN_ITEM` using its `action` property,
+     * and use the value of its `id` property.
+     */
+    action_id: string;
+}
+/**
+ * The details of the received item to be removed.
+ *
+ * @property return_id - The ID of the return to remove the item from.
+ * @property action_id - The ID of the action associated with the item to remove.
+ * Every item has an `actions` property, whose value is an array of actions.
+ * You can find an action with the name `RECEIVE_RETURN_ITEM` using its `action` property,
+ * and use the value of its `id` property.
+ */
+export interface DeleteRequestItemReceiveReturnWorkflowInput extends DeleteRequestItemReturnWorkflowInput {
+}
+export interface DeleteOrderClaimRequestItemReturnWorkflowInput extends DeleteRequestItemReturnWorkflowInput {
+}
+//# sourceMappingURL=request-item-return.d.ts.map

package/dist/workflow/order/request-item-return.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-item-return.d.ts","sourceRoot":"","sources":["../../../src/workflow/order/request-item-return.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAC7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAExD;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,KAAK,EAAE,gBAAgB,EAAE,CAAA;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACnD;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,IAAI,EAAE;QACJ;;WAEG;QACH,QAAQ,CAAC,EAAE,cAAc,CAAA;QACzB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QAC7B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KAC1B,CAAA;CACF;AAED;;GAEG;AACH,MAAM,WAAW,2CAA2C;IAC1D;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,KAAK,EAAE,gBAAgB,EAAE,CAAA;CAC1B;AACD,MAAM,WAAW,iDAAiD;IAChE,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,wCAAwC;IACvD;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,KAAK,EAAE,gBAAgB,EAAE,CAAA;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACnD;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,2CACf,SAAQ,oCAAoC;CAAG;AAEjD,MAAM,WAAW,8CACf,SAAQ,oCAAoC;CAAG"}

package/dist/workflow/order/request-item-return.js

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

package/dist/workflow/order/request-item-return.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-item-return.js","sourceRoot":"","sources":["../../../src/workflow/order/request-item-return.ts"],"names":[],"mappings":""}

package/dist/workflow/order/request-transfer.d.ts

@@ -0,0 +1,24 @@
+export interface RequestOrderTransferWorkflowInput {
+    /**
+     * The ID of the order to transfer.
+     */
+    order_id: string;
+    /**
+     * The ID of the customer to transfer the order to.
+     */
+    customer_id: string;
+    /**
+     * The ID of the logged in user requesting the transfer.
+     * Can be an admin user or a customer.
+     */
+    logged_in_user: string;
+    /**
+     * Details of the transfer request.
+     */
+    description?: string;
+    /**
+     * A note viewed by admin users only.
+     */
+    internal_note?: string;
+}
+//# sourceMappingURL=request-transfer.d.ts.map

package/dist/workflow/order/request-transfer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-transfer.d.ts","sourceRoot":"","sources":["../../../src/workflow/order/request-transfer.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB"}

package/dist/workflow/order/request-transfer.js

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

package/dist/workflow/order/request-transfer.js.map

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