@medusajs/types 1.12.0-snapshot-20240405070935 → 1.12.0-snapshot-20240406075900

package/dist/cart/common.d.ts

@@ -1,64 +1,78 @@
 import { BaseFilterable } from "../dal";
 import { OperatorMap } from "../dal/utils";
+/**
+ * The adjustment line details.
+ */
 export interface AdjustmentLineDTO {
     /**
      * The ID of the adjustment line
      */
     id: string;
     /**
-     * The code of the adjustment line
+     * The code of the promotion that lead to
+     * this adjustment.
      */
     code?: string;
     /**
-     * The amount of the adjustment line
+     * The amount to adjust the original amount with.
      */
     amount: number;
     /**
-     * The ID of the associated cart
+     * The ID of the associated cart.
      */
     cart_id: string;
     /**
-     * The description of the adjustment line
+     * The description of the adjustment line.
      */
     description?: string;
     /**
-     * The ID of the associated promotion
+     * The ID of the associated promotion.
      */
     promotion_id?: string;
     /**
-     * The ID of the associated provider
+     * The ID of the associated provider.
      */
     provider_id?: string;
     /**
-     * When the adjustment line was created
+     * When the adjustment line was created.
      */
     created_at: Date | string;
     /**
-     * When the adjustment line was updated
+     * When the adjustment line was updated.
      */
     updated_at: Date | string;
 }
+/**
+ * The shipping method adjustment details.
+ */
 export interface ShippingMethodAdjustmentDTO extends AdjustmentLineDTO {
     /**
-     * The associated shipping method
+     * The associated shipping method.
      */
     shipping_method: CartShippingMethodDTO;
     /**
-     * The ID of the associated shipping method
+     * The ID of the associated shipping method.
      */
     shipping_method_id: string;
 }
+/**
+ * The line item adjustment details.
+ */
 export interface LineItemAdjustmentDTO extends AdjustmentLineDTO {
     /**
-     * The associated line item
+     * The associated line item.
+     *
      * @expandable
      */
     item: CartLineItemDTO;
     /**
-     * The associated line item
+     * The ID of the associated line item.
      */
     item_id: string;
 }
+/**
+ * The tax line details.
+ */
 export interface TaxLineDTO {
     /**
      * The ID of the tax line
@@ -69,97 +83,106 @@ export interface TaxLineDTO {
      */
     description?: string;
     /**
-     * The ID of the associated tax rate
+     * The ID of the associated tax rate.
      */
     tax_rate_id?: string;
     /**
-     * The code of the tax line
+     * The code of the tax line.
      */
     code: string;
     /**
-     * The rate of the tax line
+     * The rate of the tax line.
      */
     rate: number;
     /**
-     * The ID of the associated provider
+     * The ID of the associated provider.
      */
     provider_id?: string;
     /**
-     * When the tax line was created
+     * When the tax line was created.
      */
     created_at: Date | string;
     /**
-     * When the tax line was updated
+     * When the tax line was updated.
      */
     updated_at: Date | string;
 }
+/**
+ * The shipping method tax line details.
+ */
 export interface ShippingMethodTaxLineDTO extends TaxLineDTO {
     /**
-     * The associated shipping method
+     * The associated shipping method.
      */
     shipping_method: CartShippingMethodDTO;
     /**
-     * The ID of the associated shipping method
+     * The ID of the associated shipping method.
      */
     shipping_method_id: string;
 }
+/**
+ * The line item tax line details.
+ */
 export interface LineItemTaxLineDTO extends TaxLineDTO {
     /**
-     * The associated line item
+     * The associated line item.
      */
     item: CartLineItemDTO;
     /**
-     * The ID of the associated line item
+     * The ID of the associated line item.
      */
     item_id: string;
 }
+/**
+ * The cart address details.
+ */
 export interface CartAddressDTO {
     /**
-     * The ID of the address
+     * The ID of the address.
      */
     id: string;
     /**
-     * The customer ID of the address
+     * The customer ID of the address.
      */
     customer_id?: string;
     /**
-     * The first name of the address
+     * The first name of the address.
      */
     first_name?: string;
     /**
-     * The last name of the address
+     * The last name of the address.
      */
     last_name?: string;
     /**
-     * The phone number of the address
+     * The phone number of the address.
      */
     phone?: string;
     /**
-     * The company of the address
+     * The company of the address.
      */
     company?: string;
     /**
-     * The first address line of the address
+     * The first address line of the address.
      */
     address_1?: string;
     /**
-     * The second address line of the address
+     * The second address line of the address.
      */
     address_2?: string;
     /**
-     * The city of the address
+     * The city of the address.
      */
     city?: string;
     /**
-     * The country code of the address
+     * The country code of the address.
      */
     country_code?: string;
     /**
-     * The province/state of the address
+     * The province/state of the address.
      */
     province?: string;
     /**
-     * The postal code of the address
+     * The postal code of the address.
      */
     postal_code?: string;
     /**
@@ -175,33 +198,36 @@ export interface CartAddressDTO {
      */
     updated_at: Date | string;
 }
+/**
+ * The cart shipping method details.
+ */
 export interface CartShippingMethodDTO {
     /**
-     * The ID of the shipping method
+     * The ID of the shipping method.
      */
     id: string;
     /**
-     * The ID of the associated cart
+     * The ID of the associated cart.
      */
     cart_id: string;
     /**
-     * The name of the shipping method
+     * The name of the shipping method.
      */
     name: string;
     /**
-     * The description of the shipping method
+     * The description of the shipping method.
      */
     description?: string;
     /**
-     * The price of the shipping method
+     * The price of the shipping method.
      */
     amount: number;
     /**
-     * Whether the shipping method price is tax inclusive or not
+     * Whether the shipping method price is tax inclusive.
      */
     is_tax_inclusive: boolean;
     /**
-     * The ID of the shipping option the method was created from
+     * The ID of the shipping option the method was created from.
      */
     shipping_option_id?: string;
     /**
@@ -232,28 +258,91 @@ export interface CartShippingMethodDTO {
      * When the shipping method was updated.
      */
     updated_at: Date | string;
+    /**
+     * The original total of the cart shipping method.
+     */
     original_total: number;
+    /**
+     * The original subtotal of the cart shipping method.
+     */
     original_subtotal: number;
+    /**
+     * The original tax total of the cart shipping method.
+     */
     original_tax_total: number;
+    /**
+     * The total of the cart shipping method.
+     */
     total: number;
+    /**
+     * The subtotal of the cart shipping method.
+     */
     subtotal: number;
+    /**
+     * The tax total of the cart shipping method.
+     */
     tax_total: number;
+    /**
+     * The discount total of the cart shipping method.
+     */
     discount_total: number;
+    /**
+     * The discount tax total of the cart shipping method.
+     */
     discount_tax_total: number;
 }
+/**
+ * The cart line item totals details.
+ */
 export interface CartLineItemTotalsDTO {
+    /**
+     * The original total of the cart line item.
+     */
     original_total: number;
+    /**
+     * The original subtotal of the cart line item.
+     */
     original_subtotal: number;
+    /**
+     * The original tax total of the cart line item.
+     */
     original_tax_total: number;
+    /**
+     * The item total of the cart line item.
+     */
     item_total: number;
+    /**
+     * The item subtotal of the cart line item.
+     */
     item_subtotal: number;
+    /**
+     * The item tax total of the cart line item.
+     */
     item_tax_total: number;
+    /**
+     * The total of the cart line item.
+     */
     total: number;
+    /**
+     * The subtotal of the cart line item.
+     */
     subtotal: number;
+    /**
+     * The tax total of the cart line item.
+     */
     tax_total: number;
+    /**
+     * The discount total of the cart line item.
+     */
     discount_total: number;
+    /**
+     * The discount tax total of the cart line item.
+     */
     discount_tax_total: number;
 }
+/**
+ * The cart line item details.
+ */
 export interface CartLineItemDTO extends CartLineItemTotalsDTO {
     /**
      * The ID of the line item.
@@ -268,79 +357,79 @@ export interface CartLineItemDTO extends CartLineItemTotalsDTO {
      */
     subtitle?: string;
     /**
-     * The url of the line item thumbnail.
+     * The line item's thumbnail.
      */
     thumbnail?: string;
     /**
-     * The line item quantity
+     * The line item's quantity in the cart.
      */
     quantity: number;
     /**
-     * The product ID of the line item.
+     * The ID of the associated product.
      */
     product_id?: string;
     /**
-     * The product title of the line item.
+     * The title of the associated product.
      */
     product_title?: string;
     /**
-     * The product description of the line item.
+     * The description of the associated product.
      */
     product_description?: string;
     /**
-     * The product subtitle of the line item.
+     * The subtitle of the associated product.
      */
     product_subtitle?: string;
     /**
-     * The product type of the line item.
+     * The type of the associated product.
      */
     product_type?: string;
     /**
-     * The product collection of the line item.
+     * The collection of the associated product.
      */
     product_collection?: string;
     /**
-     * The product handle of the line item.
+     * The handle of the associated product.
      */
     product_handle?: string;
     /**
-     * The variant ID of the line item.
+     * The associated variant's ID of the line item.
      */
     variant_id?: string;
     /**
-     * The variant sku of the line item.
+     * The sku of the associated variant.
      */
     variant_sku?: string;
     /**
-     * The variant barcode of the line item.
+     * The barcode of the associated variant.
      */
     variant_barcode?: string;
     /**
-     * The variant title of the line item.
+     * The title of the associated variant.
      */
     variant_title?: string;
     /**
-     * The variant option values of the line item.
+     * The option values of the associated variant.
      */
     variant_option_values?: Record<string, unknown>;
     /**
-     * Whether the line item requires shipping or not
+     * Whether the line item requires shipping.
      */
     requires_shipping: boolean;
     /**
-     * Whether the line item is discountable or not
+     * Whether the line item is discountable.
      */
     is_discountable: boolean;
     /**
-     * Whether the line item price is tax inclusive or not
+     * Whether the line item price is tax inclusive.
      */
     is_tax_inclusive: boolean;
     /**
-     * The original price of the item before an adjustment or a sale.
+     * The calculated price of the line item.
      */
     compare_at_unit_price?: number;
     /**
-     * The price of the item
+     * The unit price of the item.
      */
     unit_price: number;
     /**
@@ -382,6 +471,9 @@ export interface CartLineItemDTO extends CartLineItemTotalsDTO {
      */
     deleted_at?: Date;
 }
+/**
+ * The cart details.
+ */
 export interface CartDTO {
     /**
      * The ID of the cart.
@@ -392,7 +484,7 @@ export interface CartDTO {
      */
     region_id?: string;
     /**
-     * The ID of the customer on the cart.
+     * The ID of the associated customer
      */
     customer_id?: string;
     /**
@@ -400,7 +492,7 @@ export interface CartDTO {
      */
     sales_channel_id?: string;
     /**
-     * The email of the cart.
+     * The email of the customer that owns the cart.
      */
     email?: string;
     /**
@@ -443,115 +535,404 @@ export interface CartDTO {
      * When the cart was updated.
      */
     updated_at?: string | Date;
+    /**
+     * The original item total of the cart.
+     */
     original_item_total: number;
+    /**
+     * The original item subtotal of the cart.
+     */
     original_item_subtotal: number;
+    /**
+     * The original item tax total of the cart.
+     */
     original_item_tax_total: number;
+    /**
+     * The item total of the cart.
+     */
     item_total: number;
+    /**
+     * The item subtotal of the cart.
+     */
     item_subtotal: number;
+    /**
+     * The item tax total of the cart.
+     */
     item_tax_total: number;
+    /**
+     * The original total of the cart.
+     */
     original_total: number;
+    /**
+     * The original subtotal of the cart.
+     */
     original_subtotal: number;
+    /**
+     * The original tax total of the cart.
+     */
     original_tax_total: number;
+    /**
+     * The total of the cart.
+     */
     total: number;
+    /**
+     * The subtotal of the cart.
+     */
     subtotal: number;
+    /**
+     * The tax total of the cart.
+     */
     tax_total: number;
+    /**
+     * The discount total of the cart.
+     */
     discount_total: number;
+    /**
+     * The raw discount total of the cart.
+     */
     raw_discount_total: any;
+    /**
+     * The discount tax total of the cart.
+     */
     discount_tax_total: number;
+    /**
+     * The gift card total of the cart.
+     */
     gift_card_total: number;
+    /**
+     * The gift card tax total of the cart.
+     */
     gift_card_tax_total: number;
+    /**
+     * The shipping total of the cart.
+     */
     shipping_total: number;
+    /**
+     * The shipping subtotal of the cart.
+     */
     shipping_subtotal: number;
+    /**
+     * The shipping tax total of the cart.
+     */
     shipping_tax_total: number;
+    /**
+     * The original shipping total of the cart.
+     */
     original_shipping_total: number;
+    /**
+     * The original shipping subtotal of the cart.
+     */
     original_shipping_subtotal: number;
+    /**
+     * The original shipping tax total of the cart.
+     */
     original_shipping_tax_total: number;
 }
+/**
+ * The filters to apply on the retrieved carts.
+ */
 export interface FilterableCartProps extends BaseFilterable<FilterableCartProps> {
+    /**
+     * The IDs to filter the carts by.
+     */
     id?: string | string[];
+    /**
+     * Filter the carts by the ID of their associated sales channel.
+     */
     sales_channel_id?: string | string[] | OperatorMap<string>;
+    /**
+     * Filter the carts by the ID of their associated customer.
+     */
     customer_id?: string | string[] | OperatorMap<string>;
+    /**
+     * Filter the carts by the ID of their associated region.
+     */
     region_id?: string | string[] | OperatorMap<string>;
+    /**
+     * Filter the carts by their creation date.
+     */
     created_at?: OperatorMap<string>;
+    /**
+     * Filter the carts by their update date.
+     */
     updated_at?: OperatorMap<string>;
 }
+/**
+ * The filters to apply on the retrieved addresss.
+ */
 export interface FilterableAddressProps extends BaseFilterable<FilterableAddressProps> {
+    /**
+     * The IDs to filter the addresss by.
+     */
     id?: string | string[];
 }
+/**
+ * The filters to apply on the retrieved line items.
+ */
 export interface FilterableLineItemProps extends BaseFilterable<FilterableLineItemProps> {
+    /**
+     * The IDs to filter the line items by.
+     */
     id?: string | string[];
+    /**
+     * Filter the line items by the ID of their associated cart.
+     */
     cart_id?: string | string[];
+    /**
+     * Filter the line items by their title.
+     */
     title?: string;
+    /**
+     * Filter the line items by the ID of their associated variant.
+     */
     variant_id?: string | string[];
+    /**
+     * Filter the line items by the ID of their associated product.
+     */
     product_id?: string | string[];
 }
+/**
+ * The filters to apply on the retrieved line item adjustments.
+ */
 export interface FilterableLineItemAdjustmentProps extends BaseFilterable<FilterableLineItemAdjustmentProps> {
+    /**
+     * The IDs to filter the line item adjustments by.
+     */
     id?: string | string[];
+    /**
+     * Filter the adjustments by the ID of their associated line item.
+     */
     item_id?: string | string[];
+    /**
+     * Filter the line item adjustments by the ID of their associated promotion.
+     */
     promotion_id?: string | string[];
+    /**
+     * Filter the line item adjustments by the ID of their associated provider.
+     */
     provider_id?: string | string[];
+    /**
+     * Filter the adjustments by their associated line item.
+     */
     item?: FilterableLineItemProps;
 }
+/**
+ * The filters to apply on the retrieved shipping methods.
+ */
 export interface FilterableShippingMethodProps extends BaseFilterable<FilterableShippingMethodProps> {
+    /**
+     * The IDs to filter the shipping methods by.
+     */
     id?: string | string[];
+    /**
+     * Filter the shipping methods by the ID of their associated cart.
+     */
     cart_id?: string | string[];
+    /**
+     * Filter the shipping methods by their name.
+     */
     name?: string;
+    /**
+     * Filter the shipping methods by the ID of their associated shipping option.
+     */
     shipping_option_id?: string | string[];
 }
+/**
+ * The filters to apply on the retrieved shipping method adjustments.
+ */
 export interface FilterableShippingMethodAdjustmentProps extends BaseFilterable<FilterableShippingMethodAdjustmentProps> {
+    /**
+     * The IDs to filter the shipping method adjustments by.
+     */
     id?: string | string[];
+    /**
+     * Filter the adjustments by the ID of their associated shipping method.
+     */
     shipping_method_id?: string | string[];
+    /**
+     * Filter the shipping method adjustments by the ID of their associated promotion.
+     */
     promotion_id?: string | string[];
+    /**
+     * Filter the shipping method adjustments by the ID of their associated provider.
+     */
     provider_id?: string | string[];
+    /**
+     * Filter the adjustments by their associated shipping method.
+     */
     shipping_method?: FilterableShippingMethodProps;
 }
+/**
+ * The filters to apply on the retrieved line item tax lines.
+ */
 export interface FilterableLineItemTaxLineProps extends BaseFilterable<FilterableLineItemTaxLineProps> {
+    /**
+     * The IDs to filter the line item tax lines by.
+     */
     id?: string | string[];
+    /**
+     * Filter the line item tax lines by their description.
+     */
     description?: string;
+    /**
+     * Filter the line item tax lines by their code.
+     */
     code?: string | string[];
+    /**
+     * Filter the line item tax lines by the ID of their associated tax rate.
+     */
     tax_rate_id?: string | string[];
+    /**
+     * Filter the line item tax lines by the ID of their associated provider.
+     */
     provider_id?: string | string[];
+    /**
+     * Filter the tax lines by the ID of their associated line item.
+     */
     item_id?: string | string[];
+    /**
+     * Filter the tax lines by their associated line item.
+     */
     item?: FilterableLineItemProps;
 }
+/**
+ * The filters to apply on the retrieved shipping method tax lines.
+ */
 export interface FilterableShippingMethodTaxLineProps extends BaseFilterable<FilterableShippingMethodTaxLineProps> {
+    /**
+     * The IDs to filter the shipping method tax lines by.
+     */
     id?: string | string[];
+    /**
+     * Filter the shipping method tax lines by their description.
+     */
     description?: string;
+    /**
+     * Filter the shipping method tax lines by their code.
+     */
     code?: string | string[];
+    /**
+     * Filter the shipping method tax lines by the ID of their associated tax rate.
+     */
     tax_rate_id?: string | string[];
+    /**
+     * Filter the shipping method tax lines by the ID of their associated provider.
+     */
     provider_id?: string | string[];
+    /**
+     * Filter the tax lines by the ID of their associated shipping method.
+     */
     shipping_method_id?: string | string[];
+    /**
+     * Filter the tax lines by their associated shipping method.
+     */
     shipping_method?: FilterableShippingMethodProps;
 }
 /**
  * TODO: Remove this in favor of CartDTO, when module is released
+ *
  * @deprecated Use CartDTO instead
  */
 export type legacy_CartDTO = {
+    /**
+     * The ID of the cart.
+     */
     id?: string;
+    /**
+     * The email of the cart.
+     */
     email?: string;
+    /**
+     * The associated billing address's ID.
+     */
     billing_address_id?: string;
+    /**
+     * The associated shipping address's ID.
+     */
     shipping_address_id?: string;
+    /**
+     * The associated region's ID.
+     */
     region_id?: string;
+    /**
+     * The associated customer's ID.
+     */
     customer_id?: string;
+    /**
+     * The associated payment's ID.
+     */
     payment_id?: string;
+    /**
+     * The associated date.
+     */
     completed_at?: Date;
+    /**
+     * The associated date.
+     */
     payment_authorized_at?: Date;
+    /**
+     * The idempotency key of the cart.
+     */
     idempotency_key?: string;
+    /**
+     * The context of the cart.
+     */
     context?: Record<string, unknown>;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, unknown>;
+    /**
+     * The associated sales channel's ID.
+     */
     sales_channel_id?: string | null;
+    /**
+     * The shipping total of the cart.
+     */
     shipping_total?: number;
+    /**
+     * The discount total of the cart.
+     */
     discount_total?: number;
+    /**
+     * The raw discount total of the cart.
+     */
     raw_discount_total?: number;
+    /**
+     * The item tax total of the cart.
+     */
     item_tax_total?: number | null;
+    /**
+     * The shipping tax total of the cart.
+     */
     shipping_tax_total?: number | null;
+    /**
+     * The tax total of the cart.
+     */
     tax_total?: number | null;
+    /**
+     * The refunded total of the cart.
+     */
     refunded_total?: number;
+    /**
+     * The total of the cart.
+     */
     total?: number;
+    /**
+     * The subtotal of the cart.
+     */
     subtotal?: number;
+    /**
+     * The refundable amount of the cart.
+     */
     refundable_amount?: number;
+    /**
+     * The gift card total of the cart.
+     */
     gift_card_total?: number;
+    /**
+     * The gift card tax total of the cart.
+     */
     gift_card_tax_total?: number;
 };
 //# sourceMappingURL=common.d.ts.map