@medusajs/types 1.12.0-preview-20240925125714 → 1.12.0-preview-20240930112011

package/dist/order/common.d.ts

@@ -3,11 +3,12 @@ import { OperatorMap } from "../dal/utils";
 import { FulfillmentDTO } from "../fulfillment";
 import { PaymentCollectionDTO } from "../payment";
 import { BigNumberInput, BigNumberRawValue, BigNumberValue } from "../totals";
-import { ClaimReason } from "./mutations";
+import { ClaimReason, OrderClaimType } from "./mutations";
 /**
  * The change action's type.
  */
 export type ChangeActionType = "CANCEL_RETURN_ITEM" | "FULFILL_ITEM" | "DELIVER_ITEM" | "CANCEL_ITEM_FULFILLMENT" | "ITEM_ADD" | "ITEM_REMOVE" | "ITEM_UPDATE" | "RECEIVE_DAMAGED_RETURN_ITEM" | "RECEIVE_RETURN_ITEM" | "RETURN_ITEM" | "SHIPPING_ADD" | "SHIPPING_REMOVE" | "SHIP_ITEM" | "WRITE_OFF_ITEM" | "REINSTATE_ITEM";
+export type OrderChangeStatus = "confirmed" | "declined" | "requested" | "pending" | "canceled";
 /**
  * @interface
  *
@@ -80,6 +81,8 @@ export type OrderSummaryDTO = {
     pending_difference: BigNumberValue;
     /**
      * The raw pending difference of the order.
+     *
+     * @ignore
      */
     raw_pending_difference: BigNumberRawValue;
 };
@@ -215,10 +218,14 @@ export interface OrderShippingMethodTaxLineDTO extends OrderTaxLineDTO {
     subtotal: BigNumberValue;
     /**
      * The raw total tax relative to the shipping method.
+     *
+     * @ignore
      */
     raw_total: BigNumberRawValue;
     /**
      * The raw subtotal tax relative to the shipping method.
+     *
+     * @ignore
      */
     raw_subtotal: BigNumberRawValue;
 }
@@ -246,10 +253,14 @@ export interface OrderLineItemTaxLineDTO extends OrderTaxLineDTO {
     subtotal: BigNumberValue;
     /**
      * The raw total tax relative to the item.
+     *
+     * @ignore
      */
     raw_total: BigNumberRawValue;
     /**
      * The raw subtotal tax relative to the item.
+     *
+     * @ignore
      */
     raw_subtotal: BigNumberRawValue;
 }
@@ -344,6 +355,8 @@ export interface OrderShippingMethodDTO {
     amount: BigNumberValue;
     /**
      * The raw price of the shipping method.
+     *
+     * @ignore
      */
     raw_amount: BigNumberRawValue;
     /**
@@ -416,34 +429,50 @@ export interface OrderShippingMethodDTO {
     discount_tax_total: BigNumberValue;
     /**
      * The raw original total of the order shipping method.
+     *
+     * @ignore
      */
     raw_original_total: BigNumberRawValue;
     /**
      * The raw original subtotal of the order shipping method.
+     *
+     * @ignore
      */
     raw_original_subtotal: BigNumberRawValue;
     /**
      * The raw original tax total of the order shipping method.
+     *
+     * @ignore
      */
     raw_original_tax_total: BigNumberRawValue;
     /**
      * The raw total of the order shipping method.
+     *
+     * @ignore
      */
     raw_total: BigNumberRawValue;
     /**
      * The raw subtotal of the order shipping method.
+     *
+     * @ignore
      */
     raw_subtotal: BigNumberRawValue;
     /**
      * The raw tax total of the order shipping method.
+     *
+     * @ignore
      */
     raw_tax_total: BigNumberRawValue;
     /**
      * The raw discount total of the order shipping method.
+     *
+     * @ignore
      */
     raw_discount_total: BigNumberRawValue;
     /**
      * The raw discount tax total of the order shipping method.
+     *
+     * @ignore
      */
     raw_discount_tax_total: BigNumberRawValue;
 }
@@ -505,54 +534,80 @@ export interface OrderLineItemTotalsDTO {
     refundable_total_per_unit: BigNumberValue;
     /**
      * The raw original total of the order line item.
+     *
+     * @ignore
      */
     raw_original_total: BigNumberRawValue;
     /**
      * The raw original subtotal of the order line item.
+     *
+     * @ignore
      */
     raw_original_subtotal: BigNumberRawValue;
     /**
      * The raw original tax total of the order line item.
+     *
+     * @ignore
      */
     raw_original_tax_total: BigNumberRawValue;
     /**
      * The raw item total of the order line item.
+     *
+     * @ignore
      */
     raw_item_total: BigNumberRawValue;
     /**
      * The raw item subtotal of the order line item.
+     *
+     * @ignore
      */
     raw_item_subtotal: BigNumberRawValue;
     /**
      * The raw item tax total of the order line item.
+     *
+     * @ignore
      */
     raw_item_tax_total: BigNumberRawValue;
     /**
      * The raw total of the order line item.
+     *
+     * @ignore
      */
     raw_total: BigNumberRawValue;
     /**
      * The raw subtotal of the order line item.
+     *
+     * @ignore
      */
     raw_subtotal: BigNumberRawValue;
     /**
      * The raw tax total of the order line item.
+     *
+     * @ignore
      */
     raw_tax_total: BigNumberRawValue;
     /**
      * The raw discount total of the order line item.
+     *
+     * @ignore
      */
     raw_discount_total: BigNumberRawValue;
     /**
      * The raw discount tax total of the order line item.
+     *
+     * @ignore
      */
     raw_discount_tax_total: BigNumberRawValue;
     /**
      * The raw refundable total of the order line item..
+     *
+     * @ignore
      */
     raw_refundable_total: BigNumberRawValue;
     /**
      * The raw  refundable total per unit of the order line item.
+     *
+     * @ignore
      */
     raw_refundable_total_per_unit: BigNumberRawValue;
 }
@@ -642,6 +697,8 @@ export interface OrderLineItemDTO extends OrderLineItemTotalsDTO {
     compare_at_unit_price?: number;
     /**
      * The raw compare at unit price of the line item.
+     *
+     * @ignore
      */
     raw_compare_at_unit_price?: BigNumberRawValue;
     /**
@@ -650,6 +707,8 @@ export interface OrderLineItemDTO extends OrderLineItemTotalsDTO {
     unit_price: number;
     /**
      * The raw unit price of the line item.
+     *
+     * @ignore
      */
     raw_unit_price: BigNumberRawValue;
     /**
@@ -658,6 +717,8 @@ export interface OrderLineItemDTO extends OrderLineItemTotalsDTO {
     quantity: number;
     /**
      * The raw quantity of the line item.
+     *
+     * @ignore
      */
     raw_quantity: BigNumberRawValue;
     /**
@@ -713,6 +774,8 @@ export interface OrderItemDTO {
     quantity: number;
     /**
      * The raw quantity of the order line item.
+     *
+     * @ignore
      */
     raw_quantity: BigNumberRawValue;
     /**
@@ -721,6 +784,8 @@ export interface OrderItemDTO {
     fulfilled_quantity: number;
     /**
      * The raw fulfilled quantity of the order line item.
+     *
+     * @ignore
      */
     raw_fulfilled_quantity: BigNumberRawValue;
     /**
@@ -729,6 +794,8 @@ export interface OrderItemDTO {
     delivered_quantity: number;
     /**
      * The raw delivered quantity of the order line item.
+     *
+     * @ignore
      */
     raw_delivered_quantity: BigNumberRawValue;
     /**
@@ -737,6 +804,8 @@ export interface OrderItemDTO {
     shipped_quantity: number;
     /**
      * The raw shipped quantity of the order line item.
+     *
+     * @ignore
      */
     raw_shipped_quantity: BigNumberRawValue;
     /**
@@ -745,6 +814,8 @@ export interface OrderItemDTO {
     return_requested_quantity: number;
     /**
      * The raw quantity of return requested for the order line item.
+     *
+     * @ignore
      */
     raw_return_requested_quantity: BigNumberRawValue;
     /**
@@ -753,6 +824,8 @@ export interface OrderItemDTO {
     return_received_quantity: number;
     /**
      * The raw quantity of return received for the order line item.
+     *
+     * @ignore
      */
     raw_return_received_quantity: BigNumberRawValue;
     /**
@@ -761,6 +834,8 @@ export interface OrderItemDTO {
     return_dismissed_quantity: number;
     /**
      * The raw quantity of return dismissed for the order line item.
+     *
+     * @ignore
      */
     raw_return_dismissed_quantity: BigNumberRawValue;
     /**
@@ -769,6 +844,8 @@ export interface OrderItemDTO {
     written_off_quantity: number;
     /**
      * The raw quantity of written off for the order line item.
+     *
+     * @ignore
      */
     raw_written_off_quantity: BigNumberRawValue;
     /**
@@ -877,11 +954,11 @@ export interface OrderDTO {
     /**
      * When the order was created.
      */
-    created_at?: string | Date;
+    created_at: string | Date;
     /**
      * When the order was updated.
      */
-    updated_at?: string | Date;
+    updated_at: string | Date;
     /**
      * The original item total of the order.
      */
@@ -976,90 +1053,134 @@ export interface OrderDTO {
     original_shipping_tax_total: BigNumberValue;
     /**
      * The raw original item total of the order.
+     *
+     * @ignore
      */
     raw_original_item_total: BigNumberRawValue;
     /**
      * The raw original item subtotal of the order.
+     *
+     * @ignore
      */
     raw_original_item_subtotal: BigNumberRawValue;
     /**
      * The raw original item tax total of the order.
+     *
+     * @ignore
      */
     raw_original_item_tax_total: BigNumberRawValue;
     /**
      * The raw item total of the order.
+     *
+     * @ignore
      */
     raw_item_total: BigNumberRawValue;
     /**
      * The raw item subtotal of the order.
+     *
+     * @ignore
      */
     raw_item_subtotal: BigNumberRawValue;
     /**
      * The raw item tax total of the order.
+     *
+     * @ignore
      */
     raw_item_tax_total: BigNumberRawValue;
     /**
      * The raw original total of the order.
+     *
+     * @ignore
      */
     raw_original_total: BigNumberRawValue;
     /**
      * The raw original subtotal of the order.
+     *
+     * @ignore
      */
     raw_original_subtotal: BigNumberRawValue;
     /**
      * The raw original tax total of the order.
+     *
+     * @ignore
      */
     raw_original_tax_total: BigNumberRawValue;
     /**
      * The raw total of the order.
+     *
+     * @ignore
      */
     raw_total: BigNumberRawValue;
     /**
      * The raw subtotal of the order. (Excluding taxes)
+     *
+     * @ignore
      */
     raw_subtotal: BigNumberRawValue;
     /**
      * The raw tax total of the order.
+     *
+     * @ignore
      */
     raw_tax_total: BigNumberRawValue;
     /**
      * The raw discount total of the order.
+     *
+     * @ignore
      */
     raw_discount_total: BigNumberRawValue;
     /**
      * The raw discount tax total of the order.
+     *
+     * @ignore
      */
     raw_discount_tax_total: BigNumberRawValue;
     /**
      * The raw gift card total of the order.
+     *
+     * @ignore
      */
     raw_gift_card_total: BigNumberRawValue;
     /**
      * The raw gift card tax total of the order.
+     *
+     * @ignore
      */
     raw_gift_card_tax_total: BigNumberRawValue;
     /**
      * The raw shipping total of the order.
+     *
+     * @ignore
      */
     raw_shipping_total: BigNumberRawValue;
     /**
      * The raw shipping subtotal of the order.
+     *
+     * @ignore
      */
     raw_shipping_subtotal: BigNumberRawValue;
     /**
      * The raw shipping tax total of the order.
+     *
+     * @ignore
      */
     raw_shipping_tax_total: BigNumberRawValue;
     /**
      * The raw original shipping total of the order.
+     *
+     * @ignore
      */
     raw_original_shipping_total: BigNumberRawValue;
     /**
      * The raw original shipping subtotal of the order.
+     *
+     * @ignore
      */
     raw_original_shipping_subtotal: BigNumberRawValue;
     /**
      * The raw original shipping tax total of the order.
+     *
+     * @ignore
      */
     raw_original_shipping_tax_total: BigNumberRawValue;
 }
@@ -1070,7 +1191,7 @@ type ReturnStatus = "requested" | "received" | "partially_received" | "canceled"
 /**
  * The return details.
  */
-export interface ReturnDTO extends Omit<OrderDTO, "status" | "version" | "items"> {
+export interface ReturnDTO {
     /**
      * The ID of the return.
      */
@@ -1083,14 +1204,91 @@ export interface ReturnDTO extends Omit<OrderDTO, "status" | "version" | "items"
      * The refund amount of the return.
      */
     refund_amount?: BigNumberValue;
+    /**
+     * The raw refund amount of the return.
+     */
+    raw_refund_amount?: BigNumberValue;
     /**
      * The associated order's ID.
      */
     order_id: string;
+    /**
+     * The associated order.
+     */
+    order?: OrderDTO;
     /**
      * The items of the return
      */
     items: OrderReturnItemDTO[];
+    /**
+     * The associated exchange's ID.
+     */
+    exchange_id?: string;
+    /**
+     * The associated exchange.
+     */
+    exchange?: OrderExchangeDTO;
+    /**
+     * The associated claim's ID.
+     */
+    claim_id?: string;
+    /**
+     * The associated claim.
+     */
+    claim?: OrderClaimDTO;
+    /**
+     * The return's display ID.
+     */
+    display_id: number;
+    /**
+     * The ID of the location to return the items to.
+     */
+    location_id?: string;
+    /**
+     * Whether the customer should receive notifications related
+     * to updates on the return.
+     */
+    no_notification?: boolean;
+    /**
+     * The id of the user that created the return
+     */
+    created_by?: string | null;
+    /**
+     * The shipping methods used to receive the returned items.
+     */
+    shipping_methods?: OrderShippingMethodDTO[];
+    /**
+     * The return's transactions if refund is required.
+     */
+    transactions?: OrderTransactionDTO[];
+    /**
+     * Holds custom data in key-value pairs.
+     */
+    metadata: Record<string, unknown> | null;
+    /**
+     * The creation date of the return.
+     */
+    created_at?: Date | string;
+    /**
+     * The update date of the return.
+     */
+    updated_at?: Date | string;
+    /**
+     * The deletion date of the return.
+     */
+    deleted_at?: Date | string;
+    /**
+     * The cancelation date of the return.
+     */
+    canceled_at?: Date | string;
+    /**
+     * The request date of the return.
+     */
+    requested_at?: Date | string;
+    /**
+     * The receival date of the return.
+     */
+    received_at?: Date | string;
 }
 /**
  * The order return item details.
@@ -1122,6 +1320,8 @@ export interface OrderReturnItemDTO {
     quantity: number;
     /**
      * The raw quantity of the item to return.
+     *
+     * @ignore
      */
     raw_quantity: BigNumberRawValue;
     /**
@@ -1130,6 +1330,8 @@ export interface OrderReturnItemDTO {
     received_quantity?: number;
     /**
      * The raw received quantity of the return item.
+     *
+     * @ignore
      */
     raw_received_quantity?: BigNumberRawValue;
     /**
@@ -1165,6 +1367,10 @@ export interface OrderClaimItemDTO {
      * The associated item's ID.
      */
     item_id: string;
+    /**
+     * The associated item.
+     */
+    item: OrderLineItemDTO;
     /**
      * The quantity of the order claim item
      */
@@ -1175,6 +1381,8 @@ export interface OrderClaimItemDTO {
     reason: ClaimReason;
     /**
      * The raw quantity of the order claim item
+     *
+     * @ignore
      */
     raw_quantity: BigNumberRawValue;
     /**
@@ -1239,12 +1447,18 @@ export interface OrderExchangeItemDTO {
      * The associated item's ID.
      */
     item_id: string;
+    /**
+     * The associated item.
+     */
+    item: OrderLineItemDTO;
     /**
      * The quantity of the order exchange item
      */
     quantity: number;
     /**
      * The raw quantity of the order exchange item
+     *
+     * @ignore
      */
     raw_quantity: BigNumberRawValue;
     /**
@@ -1263,14 +1477,33 @@ export interface OrderExchangeItemDTO {
 /**
  * The claim details.
  */
-export interface OrderClaimDTO extends Omit<OrderDTO, "status" | "version" | "items"> {
+export interface OrderClaimDTO {
+    /**
+     * The claim's ID.
+     */
+    id: string;
+    /**
+     * The claim's type.
+     */
+    type: OrderClaimType;
     /**
      * The ID of the associated order.
      */
     order_id: string;
     /**
-     * The items to be received from the customer
-     * if the claim's type is `replace`.
+     * The associated order.
+     */
+    order?: OrderDTO;
+    /**
+     * The version of the order when the claim is applied.
+     */
+    order_version: number;
+    /**
+     * The claim's display ID.
+     */
+    display_id: number;
+    /**
+     * The items to be received from the customer.
      */
     claim_items: any[];
     /**
@@ -1296,22 +1529,66 @@ export interface OrderClaimDTO extends Omit<OrderDTO, "status" | "version" | "it
      */
     refund_amount?: BigNumberValue;
     /**
-     * The id of the user that creates the order claim
+     * The raw refund amount of the claim.
+     */
+    raw_refund_amount?: BigNumberValue;
+    /**
+     * The id of the user that created the order claim
      */
     created_by?: string | null;
+    /**
+     * The shipping methods used to send the additional items.
+     */
+    shipping_methods?: OrderShippingMethodDTO[];
+    /**
+     * The claim's transactions if additional payment is required.
+     */
+    transactions?: OrderTransactionDTO[];
+    /**
+     * Holds custom data in key-value pairs.
+     */
+    metadata: Record<string, unknown> | null;
+    /**
+     * The creation date of the claim.
+     */
+    created_at?: Date | string;
+    /**
+     * The update date of the claim.
+     */
+    updated_at?: Date | string;
+    /**
+     * The deletion date of the claim.
+     */
+    deleted_at?: Date | string;
+    /**
+     * The cancelation date of the claim.
+     */
+    canceled_at?: Date | string;
 }
 /**
  * The exchange details.
  */
-export interface OrderExchangeDTO extends Omit<OrderDTO, "status" | "version" | "items"> {
+export interface OrderExchangeDTO {
+    /**
+     * The exchange's ID.
+     */
+    id: string;
     /**
      * The associated order's ID.
      */
     order_id: string;
     /**
-     * The items to be returned from the customer.
+     * The associated order.
      */
-    return_items: any[];
+    order?: OrderDTO;
+    /**
+     * The version of the order when the exchange is applied.
+     */
+    order_version: number;
+    /**
+     * The exchange's display ID.
+     */
+    display_id: number;
     /**
      * The items to be sent to the customer.
      */
@@ -1329,6 +1606,18 @@ export interface OrderExchangeDTO extends Omit<OrderDTO, "status" | "version" |
      * - If equal to `0`, no payment is required by either sides.
      */
     difference_due?: BigNumberValue;
+    /**
+     * The raw difference due of the order exchange.
+     *
+     * - If less than `0`, the merchant owes the customer this amount.
+     * - If greater than `0`, the customer owes the merchange this amount.
+     * - If equal to `0`, no payment is required by either sides.
+     */
+    raw_difference_due?: BigNumberValue;
+    /**
+     * Whether the variants that are out of stock can be added to the exchange.
+     */
+    allow_backorder?: boolean;
     /**
      * The associated return.
      */
@@ -1338,9 +1627,37 @@ export interface OrderExchangeDTO extends Omit<OrderDTO, "status" | "version" |
      */
     return_id?: string;
     /**
-     * The id of the user that creates the order exchange
+     * The id of the user that created the order exchange
      */
     created_by?: string | null;
+    /**
+     * The shipping methods used to send the additional items.
+     */
+    shipping_methods?: OrderShippingMethodDTO[];
+    /**
+     * The exchange's transactions if additional payment is required.
+     */
+    transactions?: OrderTransactionDTO[];
+    /**
+     * Holds custom data in key-value pairs.
+     */
+    metadata: Record<string, unknown> | null;
+    /**
+     * The creation date of the exchange.
+     */
+    created_at?: Date | string;
+    /**
+     * The update date of the exchange.
+     */
+    updated_at?: Date | string;
+    /**
+     * The deletion date of the exchange.
+     */
+    deleted_at?: Date | string;
+    /**
+     * The cancelation date of the exchange.
+     */
+    canceled_at?: Date | string;
 }
 /**
  * The payment's status.
@@ -1440,7 +1757,7 @@ export interface OrderChangeDTO {
     /**
      * The status of the order change
      */
-    status: string;
+    status: OrderChangeStatus;
     /**
      * The requested by of the order change
      */
@@ -1583,6 +1900,8 @@ export interface OrderTransactionDTO {
     amount: BigNumberValue;
     /**
      * The raw amount of the transaction
+     *
+     * @ignore
      */
     raw_amount: BigNumberRawValue;
     /**
@@ -1630,6 +1949,8 @@ export interface OrderTransactionDTO {
     amount: BigNumberValue;
     /**
      * The raw amount of the transaction
+     *
+     * @ignore
      */
     raw_amount: BigNumberRawValue;
     /**
@@ -2172,6 +2493,7 @@ export interface OrderPreviewDTO extends Omit<OrderDTO, "items" | "shipping_meth
     shipping_methods: (OrderShippingMethodDTO & {
         actions?: OrderChangeActionDTO[];
     })[];
+    return_requested_total: number;
 }
 export {};
 //# sourceMappingURL=common.d.ts.map